CONTRIBUTING.md

   1 # Contributing to ev-simulator
   2
   3 You want to contribute to ev-simulator? Welcome! Please read this document to understand what you can do:
   4  * [Analyze Issues](#analyze-issues)
   5  * [Reporting Security Issues](#reporting-security-issues)
   6  * [Contribute Code](#contribute-code)
   7  * [Reporting Security Issues](#reporting-security-issues)
   8  * [Contributor License Agreement Acceptance](#contributor-license-agreement-acceptance)
   9
  10 ## Analyze Issues
  11 Analyzing issue reports can be a lot of effort. Any help is welcome!
  12 Go to [the Github issue tracker](https://github.com/SAP/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?
  13
  14 ## Issue Handling Process
  15 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.
  16
  17 ## Contribute Code
  18 You are welcome to contribute code to ev-simulator in order to fix bugs or to implement new features.
  19
  20 ## Reporting Security Issues
  21 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:
  22  * 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.
  23  * 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).
  24 Also refer to the general [SAP security information page](https://www.sap.com/corporate/en/company/security.html).
  25
  26 ## Contributor License Agreement Acceptance
  27 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.
  28 In particular you need to agree to the Individual Contributor License Agreement,
  29 which can be [found here](https://gist.github.com/CLAassistant/bd1ea8ec8aa0357414e8).
  30 (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.
  31
  32 ### Company Contributors
  33
  34 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.
  35
  36 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:
  37
  38 - Scan and e-mail it to [opensource@sap.com](mailto:opensource@sap.com)
  39 - Fax it to: +49 6227 78-45813
  40 - Send it by traditional letter to:
  41   _OSPO Core_
  42   _Dietmar-Hopp-Allee 16_
  43   _69190 Walldorf_
  44   _Germany_
  45
  46 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.