Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Reporting templates, cleanup #213

Merged
merged 15 commits into from
Jan 26, 2022
17 changes: 17 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,17 @@
* **What kind of change does this PR introduce?** (Bug fix, feature, docs update, ...)



* **What is the current behavior?** (You can also link to an open issue here)



* **What is the new behavior (if this is a feature change)? If possible add a screenshot.**



* **Does this PR introduce a breaking change?** (What changes might users need to make in their application due to this PR?)



* **Other information**:
134 changes: 134 additions & 0 deletions CODE_OF_CONDUCT.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,134 @@

# Contributor Covenant Code of Conduct

## Our Pledge

We as members, contributors, and leaders pledge to make participation in our
community a harassment-free experience for everyone, regardless of age, body
size, visible or invisible disability, ethnicity, sex characteristics, gender
identity and expression, level of experience, education, socio-economic status,
nationality, personal appearance, race, caste, color, religion, or sexual
identity and orientation.

We pledge to act and interact in ways that contribute to an open, welcoming,
diverse, inclusive, and healthy community.

## Our Standards

Examples of behavior that contributes to a positive environment for our
community include:

* Demonstrating empathy and kindness toward other people
* Being respectful of differing opinions, viewpoints, and experiences
* Giving and gracefully accepting constructive feedback
* Accepting responsibility and apologizing to those affected by our mistakes,
and learning from the experience
* Focusing on what is best not just for us as individuals, but for the overall
community

Examples of unacceptable behavior include:

* The use of sexualized language or imagery, and sexual attention or advances of
any kind
* Trolling, insulting or derogatory comments, and personal or political attacks
* Public or private harassment
* Publishing others' private information, such as a physical or email address,
without their explicit permission
* Other conduct which could reasonably be considered inappropriate in a
professional setting

## Enforcement Responsibilities

Community leaders are responsible for clarifying and enforcing our standards of
acceptable behavior and will take appropriate and fair corrective action in
response to any behavior that they deem inappropriate, threatening, offensive,
or harmful.

Community leaders have the right and responsibility to remove, edit, or reject
comments, commits, code, wiki edits, issues, and other contributions that are
not aligned to this Code of Conduct, and will communicate reasons for moderation
decisions when appropriate.

## Scope

This Code of Conduct applies within all community spaces, and also applies when
an individual is officially representing the community in public spaces.
Examples of representing our community include using an official e-mail address,
posting via an official social media account, or acting as an appointed
representative at an online or offline event.

## Enforcement

Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at
[TODO].
All complaints will be reviewed and investigated promptly and fairly.

All community leaders are obligated to respect the privacy and security of the
reporter of any incident.

## Enforcement Guidelines

Community leaders will follow these Community Impact Guidelines in determining
the consequences for any action they deem in violation of this Code of Conduct:

### 1. Correction

**Community Impact**: Use of inappropriate language or other behavior deemed
unprofessional or unwelcome in the community.

**Consequence**: A private, written warning from community leaders, providing
clarity around the nature of the violation and an explanation of why the
behavior was inappropriate. A public apology may be requested.

### 2. Warning

**Community Impact**: A violation through a single incident or series of
actions.

**Consequence**: A warning with consequences for continued behavior. No
interaction with the people involved, including unsolicited interaction with
those enforcing the Code of Conduct, for a specified period of time. This
includes avoiding interactions in community spaces as well as external channels
like social media. Violating these terms may lead to a temporary or permanent
ban.

### 3. Temporary Ban

**Community Impact**: A serious violation of community standards, including
sustained inappropriate behavior.

**Consequence**: A temporary ban from any sort of interaction or public
communication with the community for a specified period of time. No public or
private interaction with the people involved, including unsolicited interaction
with those enforcing the Code of Conduct, is allowed during this period.
Violating these terms may lead to a permanent ban.

### 4. Permanent Ban

**Community Impact**: Demonstrating a pattern of violation of community
standards, including sustained inappropriate behavior, harassment of an
individual, or aggression toward or disparagement of classes of individuals.

**Consequence**: A permanent ban from any sort of public interaction within the
community.

## Attribution

This Code of Conduct is adapted from the [Contributor Covenant][homepage],
version 2.1, available at
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].

Community Impact Guidelines were inspired by
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].

For answers to common questions about this code of conduct, see the FAQ at
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
[https://www.contributor-covenant.org/translations][translations].

[homepage]: https://www.contributor-covenant.org
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
[Mozilla CoC]: https://github.com/mozilla/diversity
[FAQ]: https://www.contributor-covenant.org/faq
[translations]: https://www.contributor-covenant.org/translations

7 changes: 4 additions & 3 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
# Contributing to *emba*
Contributions to *emba* are always welcome. This document explains the general requirements for contributions and the recommended preparation steps.
# Contributing to *EMBA*

Contributions to *EMBA* are always welcome. This document explains the general requirements for contributions and the recommended preparation steps.
It also sketches the typical integration process of patches.

## 1) Contribution Checklist
Expand All @@ -13,7 +14,7 @@ It also sketches the typical integration process of patches.
- structure patches logically, in small steps [**required**]
- one separable functionality/fix/refactoring = one patch
- do not mix those three into a single patch (e.g., first refactor, then add a new functionality that builds onto the refactoring)
- after each patch, *emba* has to work. Do not add
- after each patch, *EMBA* has to work. Do not add
even temporary breakages inside a patch series (helps when tracking down bugs)
- use `git rebase -i` to restructure a patch series

Expand Down
35 changes: 35 additions & 0 deletions CONTRIBUTORS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,35 @@
# EMBA - CONTRIBUTORS

==========================================================================================

The EMBA project is very thankful to the individuals who contributed to the project.

Want to contribute as well? Here are some suggestions:

- Create new module for a test currently not supported by EMBA
- Report or fix (unexpected) errors
- Share missing results and findings
- Share firmware where EMBA is not performing as expected
- Improve code quality
- Improve performance
- Check the current [issues](https://github.com/e-m-b-a/emba/issues) if some issue needs help

See [CONTRIBUTING.md](https://github.com/e-m-b-a/emba/blob/master/CONTRIBUTING.md) for more details.

==========================================================================================

## Contributors

These people have contributed to EMBA:

* Michael Messner (original author)
* Pascal Eckmann (original author)
* [Arnold Unterauer](https://github.com/Anemosx)
* [Benedikt Kuehne](https://github.com/BenediktMKuehne)
* [seanog8](https://github.com/seanog8)
* [Stefan Haboeck](https://github.com/StefanHaboeck)
* [firmianay](https://github.com/firmianay)
* [nightlark](https://github.com/nightlark)

==========================================================================================
EMBA - Embedded Analyzer - https://e-m-b-a.github.io/
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
<!--
EMBA - EMBEDDED LINUX ANALYZER

Copyright 2020-2021 Siemens AG
Copyright 2020-2021 Siemens Energy AG
Copyright 2020-2022 Siemens AG
Copyright 2020-2022 Siemens Energy AG

EMBA comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
welcome to redistribute it under the terms of the GNU General Public License.
Expand Down Expand Up @@ -77,7 +77,7 @@ sudo ./emba.sh -l ./log -f /firmware -p ./scan-profiles/default-scan.emba
```console
./emba.sh -l ./log -f ./firmware -D
```
*WARNING: Before using the developer mode you need a full installation of emba with `sudo ./installer.sh -F`. This installation mode needs more than 14gig of disk space.*
*WARNING: Before using the developer mode you need a full installation of EMBA with `sudo ./installer.sh -F`. This installation mode needs around 15 gigabyte of disk space and is only recommend for development environments.*

---
*EMBA* supports multiple testing and reporting [options](https://github.com/e-m-b-a/emba/wiki/Usage#arguments). For more details check the [wiki](https://github.com/e-m-b-a/emba/wiki/Usage).
Expand Down
22 changes: 17 additions & 5 deletions check_project.sh
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
#!/bin/bash

# emba - EMBEDDED LINUX ANALYZER
# EMBA - EMBEDDED LINUX ANALYZER
#
# Copyright 2020-2021 Siemens AG
# Copyright 2020-2021 Siemens Energy AG
# Copyright 2020-2022 Siemens AG
# Copyright 2020-2022 Siemens Energy AG
#
# emba comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
# EMBA comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
# welcome to redistribute it under the terms of the GNU General Public License.
# See LICENSE file for usage of this software.
#
# emba is licensed under GPLv3
# EMBA is licensed under GPLv3
#
# Author(s): Michael Messner, Pascal Eckmann

Expand All @@ -23,6 +23,7 @@ NC='\033[0m' # no color
HELP_DIR="./helpers"
MOD_DIR="./modules"
CONF_DIR="./config"
REP_DIR="./report_templates"

SOURCES=()
MODULES_TO_CHECK_ARR=()
Expand All @@ -47,6 +48,16 @@ import_helper() {
done
}

import_reporting_templates() {
REP_TEMP=$(find "$REP_DIR" -iname "*.sh" 2>/dev/null)
for LINE in $REP_TEMP; do
if (file "$LINE" | grep -q "shell script"); then
echo "$LINE"
SOURCES+=("$LINE")
fi
done
}

import_module() {
MODULES=$(find "$MOD_DIR" -iname "*.sh" 2>/dev/null)
for LINE in $MODULES; do
Expand Down Expand Up @@ -85,6 +96,7 @@ check()
echo "./emba.sh"
import_helper
import_config_scripts
import_reporting_templates
import_module

echo -e "\\n""$GREEN""Run shellcheck:""$NC""\\n"
Expand Down
4 changes: 2 additions & 2 deletions config/bin_version_strings.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# EMBA - EMBEDDED LINUX ANALYZER
#
# Copyright 2020-2021 Siemens Energy AG
# Copyright 2020-2021 Siemens AG
# Copyright 2020-2022 Siemens Energy AG
# Copyright 2020-2022 Siemens AG
#
# EMBA comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
# welcome to redistribute it under the terms of the GNU General Public License.
Expand Down
4 changes: 2 additions & 2 deletions config/bin_version_strings_links.cfg
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
# EMBA - EMBEDDED LINUX ANALYZER
#
# Copyright 2020-2021 Siemens Energy AG
# Copyright 2020-2021 Siemens AG
# Copyright 2020-2022 Siemens Energy AG
# Copyright 2020-2022 Siemens AG
#
# EMBA comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
# welcome to redistribute it under the terms of the GNU General Public License.
Expand Down
4 changes: 2 additions & 2 deletions emba.sh
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,8 @@

# EMBA - EMBEDDED LINUX ANALYZER
#
# Copyright 2020-2021 Siemens AG
# Copyright 2020-2021 Siemens Energy AG
# Copyright 2020-2022 Siemens AG
# Copyright 2020-2022 Siemens Energy AG
#
# EMBA comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
# welcome to redistribute it under the terms of the GNU General Public License.
Expand Down
10 changes: 5 additions & 5 deletions helpers/base.html
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
<!--
emba - EMBEDDED LINUX ANALYZER
EMBA - EMBEDDED LINUX ANALYZER

Copyright 2020-2021 Siemens AG
Copyright 2020-2021 Siemens Energy AG
Copyright 2020-2022 Siemens AG
Copyright 2020-2022 Siemens Energy AG

emba comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
EMBA comes with ABSOLUTELY NO WARRANTY. This is free software, and you are
welcome to redistribute it under the terms of the GNU General Public License.
See LICENSE file for usage of this software.

emba is licensed under GPLv3
EMBA is licensed under GPLv3

Author(s): Michael Messner, Pascal Eckmann, Stefan Haboeck
-->
Expand Down