|
| 1 | +# Contributing |
| 2 | + |
| 3 | +Want to contribute? Great! You can do so through the standard GitHub pull |
| 4 | +request model. For large contributions we do encourage you to file a ticket in |
| 5 | +the GitHub issues tracking system prior to any code development to coordinate |
| 6 | +with the system_modes development team early in the process. Coordinating up |
| 7 | +front helps to avoid frustration later on. |
| 8 | + |
| 9 | +Your contribution must be licensed under the Apache-2.0 license, the license |
| 10 | +used by this project. |
| 11 | + |
| 12 | +## Add / retain copyright notices |
| 13 | + |
| 14 | +Include a copyright notice and license in each new file to be contributed, |
| 15 | +consistent with the style used by this project. If your contribution contains |
| 16 | +code under the copyright of a third party, document its origin, license, and |
| 17 | +copyright holders. |
| 18 | + |
| 19 | +## Sign your work |
| 20 | + |
| 21 | +This project tracks patch provenance and licensing using a modified Developer |
| 22 | +Certificate of Origin (DCO; from [OSDL][DCO]) and Signed-off-by tags initially |
| 23 | +developed by the Linux kernel project. |
| 24 | + |
| 25 | +``` |
| 26 | +system_modes Developer's Certificate of Origin. Version 1.0 |
| 27 | +
|
| 28 | +By making a contribution to this project, I certify that: |
| 29 | +
|
| 30 | +(a) The contribution was created in whole or in part by me and I |
| 31 | + have the right to submit it under the "Apache License, Version 2.0" |
| 32 | + ("Apache-2.0"); or |
| 33 | +
|
| 34 | +(b) The contribution is based upon previous work that is covered by |
| 35 | + an appropriate open source license and I have the right under |
| 36 | + that license to submit that work with modifications, whether |
| 37 | + created in whole or in part by me, under the Apache-2.0 license; |
| 38 | + or |
| 39 | +
|
| 40 | +(c) The contribution was provided directly to me by some other |
| 41 | + person who certified (a) or (b) and I have not modified it. |
| 42 | +
|
| 43 | +(d) I understand and agree that this project and the contribution |
| 44 | + are public and that a record of the contribution (including all |
| 45 | + metadata and personal information I submit with it, including my |
| 46 | + sign-off) is maintained indefinitely and may be redistributed |
| 47 | + consistent with this project and the requirements of the Apache-2.0 |
| 48 | + license or any open source license(s) involved, where they are |
| 49 | + relevant. |
| 50 | +
|
| 51 | +(e) I am granting the contribution to this project under the terms of |
| 52 | + Apache-2.0. |
| 53 | +
|
| 54 | + http://www.apache.org/licenses/LICENSE-2.0 |
| 55 | +``` |
| 56 | + |
| 57 | +With the sign-off in a commit message you certify that you authored the patch |
| 58 | +or otherwise have the right to submit it under an open source license. The |
| 59 | +procedure is simple: To certify above system_modes Developer's Certificate of |
| 60 | +Origin 1.0 for your contribution just append a line |
| 61 | + |
| 62 | + Signed-off-by: Random J Developer <random@developer.example.org> |
| 63 | + |
| 64 | +to every commit message using your real name or your pseudonym and a valid |
| 65 | +email address. |
| 66 | + |
| 67 | +If you have set your `user.name` and `user.email` git configs you can |
| 68 | +automatically sign the commit by running the git-commit command with the `-s` |
| 69 | +option. There may be multiple sign-offs if more than one developer was |
| 70 | +involved in authoring the contribution. |
| 71 | + |
| 72 | +For a more detailed description of this procedure, please see |
| 73 | +[SubmittingPatches][] which was extracted from the Linux kernel project, and |
| 74 | +which is stored in an external repository. |
| 75 | + |
| 76 | +### Individual vs. Corporate Contributors |
| 77 | + |
| 78 | +Often employers or academic institution have ownership over code that is |
| 79 | +written in certain circumstances, so please do due diligence to ensure that |
| 80 | +you have the right to submit the code. |
| 81 | + |
| 82 | +If you are a developer who is authorized to contribute to system_modes on |
| 83 | +behalf of your employer, then please use your corporate email address in the |
| 84 | +Signed-off-by tag. Otherwise please use a personal email address. |
| 85 | + |
| 86 | +## Maintain Copyright holder / Contributor list |
| 87 | + |
| 88 | +Each contributor is responsible for identifying themselves in the |
| 89 | +[NOTICE](NOTICE) file, the project's list of copyright holders and authors. |
| 90 | +Please add the respective information corresponding to the Signed-off-by tag |
| 91 | +as part of your first pull request. |
| 92 | + |
| 93 | +If you are a developer who is authorized to contribute to system_modes on |
| 94 | +behalf of your employer, then add your company / organization to the list of |
| 95 | +copyright holders in the [NOTICE](NOTICE) file. As author of a corporate |
| 96 | +contribution you can also add your name and corporate email address as in the |
| 97 | +Signed-off-by tag. |
| 98 | + |
| 99 | +If your contribution is covered by this project's DCO's clause "(c) The |
| 100 | +contribution was provided directly to me by some other person who certified |
| 101 | +(a) or (b) and I have not modified it", please add the appropriate copyright |
| 102 | +holder(s) to the [NOTICE](NOTICE) file as part of your contribution. |
| 103 | + |
| 104 | + |
| 105 | +[DCO]: http://web.archive.org/web/20070306195036/http://osdlab.org/newsroom/press_releases/2004/2004_05_24_dco.html |
| 106 | + |
| 107 | +[SubmittingPatches]: https://github.com/wking/signed-off-by/blob/7d71be37194df05c349157a2161c7534feaf86a4/Documentation/SubmittingPatches |
0 commit comments