-# Contributing to ev-simulator
+# Contributing
-You want to contribute to ev-simulator? Welcome! Please read this document to understand what you can do:
- * [Analyze Issues](#analyze-issues)
- * [Reporting Security Issues](#reporting-security-issues)
- * [Contribute Code](#contribute-code)
- * [Reporting Security Issues](#reporting-security-issues)
- * [Contributor License Agreement Acceptance](#contributor-license-agreement-acceptance)
+## Code of Conduct
-## Analyze Issues
-Analyzing issue reports can be a lot of effort. Any help is welcome!
-Go to [the Github issue tracker](https://github.com/LucasBrazi06/ev-simulator/issues?state=open) and find an open issue which needs additional work or a bugfix. Maybe you can even find and [contribute](#contribute-code) a bugfix?
+All members of the project community must abide by the [Contributor Covenant, version 2.1](CODE_OF_CONDUCT.md).
+Only by respecting each other we can develop a productive, collaborative community.
+Instances of abusive, harassing, or otherwise unacceptable behavior may be reported by contacting [a project maintainer](.reuse/dep5).
-## Issue Handling Process
-When an issue is reported, a committer will look at it and either confirm it as a real issue (by giving the "approved" label), close it if it is not an issue, or ask for more details. Approved issues are then either assigned to a committer in GitHub, reported in our internal issue handling system, or left open as "contribution welcome" for easy or not urgent fixes. An issue that is about a real bug is closed as soon as the fix is committed.
+## Engaging in Our Project
-## Contribute Code
-You are welcome to contribute code to ev-simulator in order to fix bugs or to implement new features.
+We use GitHub to manage reviews of pull requests.
-## Reporting Security Issues
-If you find a security issue, please act responsibly and report it not in the public issue tracker, but directly to us, so we can fix it before it can be exploited:
- * SAP Customers: if the found security issue is not covered by a published security note, please report it by creating a customer message at https://service.sap.com/message.
- * Researchers/non-Customers: please send the related information to secure@sap.com using [PGP for e-mail encryption](http://global.sap.com/pc/security/keyblock.txt).
-Also refer to the general [SAP security information page](https://www.sap.com/corporate/en/company/security.html).
+- If you are a new contributor, see: [Steps to Contribute](#steps-to-contribute)
-## Contributor License Agreement Acceptance
-When you contribute (code, documentation, or anything else), you have to be aware that your contribution is covered by the same [Apache 2.0 License](http://www.apache.org/licenses/LICENSE-2.0) that is applied to ev-simulator itself.
-In particular you need to agree to the Individual Contributor License Agreement,
-which can be [found here](https://gist.github.com/CLAassistant/bd1ea8ec8aa0357414e8).
-(This applies to all contributors, including those contributing on behalf of a company). If you agree to its content, you simply have to click on the link posted by the CLA assistant as a comment to the pull request. Click it to check the CLA, then accept it on the following screen if you agree to it. CLA assistant will save this decision for upcoming contributions and will notify you if there is any change to the CLA in the meantime.
+- Before implementing your change, create an issue that describes the problem you would like to solve or the code that should be enhanced. Please note that you are willing to work on that issue.
-### Company Contributors
+- The team will review the issue and decide whether it should be implemented as a pull request. In that case, they will assign the issue to you. If the team decides against picking up the issue, the team will post a comment with an explanation.
-If employees of a company contribute code, in **addition** to the individual agreement mentioned above, one company agreement must be submitted. This is mainly for the protection of the contributing employees.
+## Steps to Contribute
-A company representative authorized to do so needs to download, fill in, and print the [Corporate Contributor License Agreement](/src/assets/cla/SAP%20CCLA.pdf) form and then proceed with one of the following options:
+Should you wish to work on an issue, please claim it first by commenting on the GitHub issue that you want to work on. This is to prevent duplicated efforts from other contributors on the same issue.
-- Scan and e-mail it to [opensource@sap.com](mailto:opensource@sap.com)
-- Fax it to: +49 6227 78-45813
-- Send it by traditional letter to:
- _OSPO Core_
- _Dietmar-Hopp-Allee 16_
- _69190 Walldorf_
- _Germany_
+If you have questions about one of the issues, please comment on them, and one of the maintainers will clarify.
-The form contains a list of employees who are authorized to contribute on behalf of your company. When this list changes, please let us know.
+## Contributing Code or Documentation
+
+You are welcome to contribute code in order to fix a bug or to implement a new feature that is logged as an issue.
+
+The following rule governs code contributions:
+
+- Contributions must be licensed under the [Apache 2.0 License](./LICENSE)
+- Due to legal reasons, contributors will be asked to accept a Developer Certificate of Origin (DCO) when they create the first pull request to this project. This happens in an automated fashion during the submission process. SAP uses [the standard DCO text of the Linux Foundation](https://developercertificate.org/).
+
+## Issues and Planning
+
+- We use GitHub issues to track bugs and enhancement requests.
+
+- Please provide as much context as possible when you open an issue. The information you provide must be comprehensive enough to reproduce that issue for the assignee.
repositories / e-mobility-charging-stations-simulator.git / blobdiff