-
Notifications
You must be signed in to change notification settings - Fork 17
Contribution Guidelines
(version 0.l, 05.04.2013)
Anyone who makes contributions to the openETCS website and to openETCS projects are considered to be Contributors. These Contributors submit contributions such as code, documentation, and other materials. Contributors, who are no committers on a certain project, do not have write access to the project infrastructure. Therefore, these contributions are accepted and applied by one of the projects committers. A Committer cannot always assume that contributed content can be freely used or redistributed. Therefore contributions need to be tracked, and a Contribution Questionaire has to be filled out.
To make a contribution to a project, please follow these steps:
- Make sure, you own the appropriate right on the contribution to publish it following the openETCS terms of use and IP policy
- Communicate your contribution with the team of committers on the respective project. If there is issue in the projects GitHub, create one
- Depending on the type of contribution:
- Create a new Gist, containing the contribution
- Create a fork of the original repository and issue a pull request see also the Fork Tutorial
- Copy the following template, create a comment on the issue in the GitHub and fill in the required information. The description of the required fiels can be found below.
############### SNIP
- Name:
- Description:
- Gist URL:
- Cryptography:
- Author(s):
I hereby declare that I accept to contribute following the openETCS terms of use and the openETCS IP policy.
http://openetcs.org/termsofuse
https://github.com/openETCS/ecosystem/wiki/IP-Policy
############### SNAP
##Description of the fields
- Name: Enter the name of the third-party library, document or code contribution.
- Description: Describe the contribution. Also provide any additional information you may have regarding intellectual property rights (patents, trademarks, etc.) related to the Contribution.
- Gist URL: Contributions should be tracked through Gist entries. Please enter the Gist url containing this contribution.
- Cryptography: Does this contribution deal in any way with cryptography? If yes, describe how the code uses cryptography and which cryptography algorithm is used. If no, enter "No" in this field.
- Author(s): If you wrote 100% of the code in this contribution, enter "Self" in this field. Otherwise, please provide contact details for each of the contributors: name, organization, email address and/or phone number, percent of contribution authored.