-
Notifications
You must be signed in to change notification settings - Fork 397
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
206 changed files
with
8,268 additions
and
2,029 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,133 @@ | ||
|
||
# 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 email 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 [email protected]. | ||
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 | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
# Contributing | ||
|
||
- [📜 Contributor License Agreement](#-contributor-license-agreement) | ||
- [🤝 Contributor Code of Conduct](#-contributor-code-of-conduct) | ||
- [🪲 Bug Reports, Issues and Questions](#-bug-reports-issues-and-questions) | ||
- [💡 Feature Requests](#-feature-requests) | ||
- [🖌️ Coding Style](#️-coding-style) | ||
- [📁 Documentation](#-documentation) | ||
|
||
## 📜 Contributor License Agreement | ||
|
||
By contributing, you agree to the Licenses of this repository: | ||
|
||
- OpenEMS Edge und Backend | ||
|
||
[Eclipse Public License version 2.0](../LICENSE-EPL-2.0) | ||
|
||
- OpenEMS UI | ||
|
||
[GNU Affero General Public License version 3](../LICENSE-AGPL-3.0) | ||
|
||
## 🤝 Contributor Code of Conduct | ||
|
||
By contributing, you agree to respect the [Code of Conduct](CODE_OF_CONDUCT.md) of this repository. | ||
|
||
## 🪲 Bug Reports, Issues and Questions | ||
|
||
A great way to contribute to the project is to send a detailed report when you encounter an issue. We always appreciate a well-written, thorough bug report, and will thank you for it! | ||
|
||
To maintain clear and organized communication, all discussions should take place in the [OpenEMS Community forum](https://community.openems.io/). This helps keep everything together and ensures that conversations are streamlined and accessible to all contributors. | ||
|
||
⚠️ *Please refrain from opening empty pull requests solely for the purpose of discussing ideas. Instead, utilize the forum to share and refine your concepts before submitting any code changes.* | ||
|
||
## 💡 Feature Requests | ||
|
||
Similar to issue reports, feature requests should be submitted to the [OpenEMS Community forum](https://community.openems.io/) for discussion. This helps ensure that all ideas are properly reviewed and discussed by the community. | ||
|
||
When submitting a feature request, please be clear about the intended outcome and how it would relate to existing features. Providing detailed information helps in evaluating the request more effectively. | ||
|
||
⚠️ *Additionally, avoid submitting duplicate feature requests. Before posting, search for existing requests, and if you find a similar or identical one, please join that discussion instead of creating a new thread.* | ||
|
||
## 🖌️ Coding Style | ||
|
||
We welcome pull-requests! While we will consider all submissions, we cannot promise that every request will be accepted. | ||
|
||
To increase your changes of a merged pull-requests and help us review your code, please follow our [coding guidelines](https://openems.github.io/openems.io/openems/latest/contribute/coding-guidelines.html). | ||
|
||
## 📁 Documentation | ||
|
||
The documentation site for OpenEMS is hosted on [https://openems.github.io/openems.io/openems/latest](https://openems.github.io/openems.io/openems/latest). We greatly appreciate contributions that improve the quality and clarity of our documentation. | ||
|
||
If you would like to contribute by updating or adding a page, please refer to our [Contribute/Documentation](https://openems.github.io/openems.io/openems/latest/contribute/documentation.html) guide for detailed instructions on how to contribute effectively to the OpenEMS documentation. |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,38 @@ | ||
name: Bug Report | ||
description: Found something you weren't expecting? Report it here! | ||
labels: ["type/bug"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
1. Please speak English, this is the language all maintainers can speak and write. | ||
2. Please ask questions or configuration/deploy problems on our [Community forum](https://community.openems.io/). | ||
3. Make sure you are using the latest release and | ||
take a moment to check that your issue hasn't been reported before. | ||
4. It's really important to provide pertinent details and logs. | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
description: | | ||
Please provide a description of your issue here. | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: screenshots | ||
attributes: | ||
label: Screenshots | ||
description: Please provide one or more screenshots, if feasible. | ||
- type: input | ||
id: os-ver | ||
attributes: | ||
label: Operating System | ||
description: The operating system you are running on. | ||
- type: textarea | ||
id: reproduce-info | ||
attributes: | ||
label: How to reproduce the Error? | ||
description: | | ||
Please provide step-by-step instructions on how to reproduce the error. | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,8 @@ | ||
blank_issues_enabled: false | ||
contact_links: | ||
- name: OpenEMS.io | ||
url: https://openems.io/ | ||
about: News and general information are posted here. | ||
- name: OpenEMS Community | ||
url: https://community.openems.io/ | ||
about: Please ask and answer questions here. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,29 @@ | ||
name: Feature Request | ||
description: Got an idea for a feature that OpenEMS is still missing? Submit your idea here! | ||
labels: ["type/enhancement"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
1. Please speak English, this is the language all maintainers can speak and write. | ||
2. Please ask questions or configuration/deploy problems on our [Community forum](https://community.openems.io/). | ||
3. Please take a moment to check that your feature hasn't already been suggested. | ||
- type: dropdown | ||
id: component | ||
attributes: | ||
label: Component | ||
description: Select the relevant component for this feature request. | ||
options: | ||
- "Edge" | ||
- "UI" | ||
- "Backend" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
placeholder: | | ||
What is the use case? | ||
validations: | ||
required: true |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,70 @@ | ||
name: Hacktoberfest | ||
description: Perfect contribution for Hacktoberfest | ||
labels: ["hacktoberfest"] | ||
body: | ||
- type: markdown | ||
attributes: | ||
value: | | ||
1. Please speak English, this is the language all maintainers can speak and write. | ||
- type: dropdown | ||
id: type | ||
attributes: | ||
label: Contribution Type | ||
description: Select the relevant Contribution type. | ||
options: | ||
- "Feature" | ||
- "Bug Fix" | ||
- "Documentation" | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: component | ||
attributes: | ||
label: Component | ||
description: Select the relevant component for this feature request. | ||
options: | ||
- "Edge" | ||
- "UI" | ||
- "Backend" | ||
validations: | ||
required: true | ||
- type: dropdown | ||
id: contributor-level | ||
attributes: | ||
label: Contributor Level | ||
description: What OpenEMS knowledge level is required for the task? | ||
options: | ||
- "Newbie" | ||
- "Casual" | ||
- "Expert" | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: description | ||
attributes: | ||
label: Description | ||
placeholder: | | ||
What purpose does the task serve? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: definition-of-done | ||
attributes: | ||
label: Definition of Done | ||
placeholder: | | ||
What result is expected? | ||
validations: | ||
required: true | ||
- type: textarea | ||
id: difficulties | ||
attributes: | ||
label: Difficulties | ||
placeholder: | | ||
What difficulties may occur? | ||
- type: markdown | ||
attributes: | ||
value: | | ||
--- | ||
- *For questions and suggestions please interact with the [community](https://community.openems.io/).* | ||
- *Do you need help getting started? Then please read the documentation [documentation](https://openems.github.io/openems.io/openems/latest/introduction.html).* | ||
- *Also read our [contribution guidelines](https://github.com/OpenEMS/openems/blob/develop/.github/CONTRIBUTING.md) before submitting code suggestions.* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
Oops, something went wrong.