|
| 1 | +# Contributing to RSU Connector |
| 2 | + |
| 3 | +Want to contribute? That's great! Any contribution is welcome, e.g. |
| 4 | +documentation, bug reports, feature request, issues, blog posts, |
| 5 | +tutorials, feature implementations, etc. You can contribute code or |
| 6 | +documentation through the standard GitHub pull request model. For large |
| 7 | +contributions we do encourage you to file a ticket in the GitHub issue |
| 8 | +tracking system prior to any development to coordinate with the RSU connector |
| 9 | +development team early in the process. Coordinating up front helps to |
| 10 | +avoid frustration later on. |
| 11 | + |
| 12 | +## Contribution Guideline |
| 13 | + |
| 14 | +* We use the GitHub [issue tracker](../../issues) and the [github-flow](https://docs.github.com/en/get-started/quickstart/github-flow) branching model. |
| 15 | + |
| 16 | +* When you want to submit a patch, you must [sign your commits](#sign-your-work). |
| 17 | + |
| 18 | +* Your contribution must be licensed under the `Apache-2.0` license, the license used by this project. |
| 19 | + |
| 20 | +* When submitting a pull-request to the project, please note / ensure the following: |
| 21 | + |
| 22 | + 0. [Update](#maintain-copyright-holder-contributor-list) the [NOTICE](NOTICE) file as part of your first pull-request. |
| 23 | + 1. If possible, keep the changes small and simple which makes the review process easier. |
| 24 | + 2. [Add / retain copyright notices](#add-retain-copyright-notices). |
| 25 | + 3. Document the code by using C++ comments for descriptions |
| 26 | + 4. Follow these [guidelines](https://chris.beams.io/posts/git-commit/) on how to write a good **commit** message. If available, include the ticket number. And don't forget the [Signed-Off-By](#sign-your-work) line. |
| 27 | + 5. Create a pull request against the `main` branch. |
| 28 | + |
| 29 | +## Legal stuff |
| 30 | + |
| 31 | +### Add / retain copyright notices |
| 32 | + |
| 33 | +Include a copyright notice and license consistent with the style used by this project. If your contribution contains code under the copyright of a third party, document its origin, license, and copyright holders. |
| 34 | + |
| 35 | +### Sign your work |
| 36 | + |
| 37 | +This project also tracks patch provenance and licensing using the Developer Certificate of Origin and Signed-off-by tags initially developed by the Linux kernel project. |
| 38 | + |
| 39 | +```text |
| 40 | +Developer Certificate of Origin |
| 41 | +Version 1.1 |
| 42 | +
|
| 43 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 44 | +1 Letterman Drive |
| 45 | +Suite D4700 |
| 46 | +San Francisco, CA, 94129 |
| 47 | +
|
| 48 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 49 | +license document, but changing it is not allowed. |
| 50 | +
|
| 51 | +
|
| 52 | +Developer's Certificate of Origin 1.1 |
| 53 | +
|
| 54 | +By making a contribution to this project, I certify that: |
| 55 | +
|
| 56 | +(a) The contribution was created in whole or in part by me and I |
| 57 | + have the right to submit it under the open source license |
| 58 | + indicated in the file; or |
| 59 | +
|
| 60 | +(b) The contribution is based upon previous work that, to the best |
| 61 | + of my knowledge, is covered under an appropriate open source |
| 62 | + license and I have the right under that license to submit that |
| 63 | + work with modifications, whether created in whole or in part |
| 64 | + by me, under the same open source license (unless I am |
| 65 | + permitted to submit under a different license), as indicated |
| 66 | + in the file; or |
| 67 | +
|
| 68 | +(c) The contribution was provided directly to me by some other |
| 69 | + person who certified (a), (b) or (c) and I have not modified |
| 70 | + it. |
| 71 | +
|
| 72 | +(d) I understand and agree that this project and the contribution |
| 73 | + are public and that a record of the contribution (including all |
| 74 | + personal information I submit with it, including my sign-off) is |
| 75 | + maintained indefinitely and may be redistributed consistent with |
| 76 | + this project or the open source license(s) involved. |
| 77 | +``` |
| 78 | + |
| 79 | +With the sign-off in a commit message you certify that you authored the |
| 80 | +patch or otherwise have the right to submit it under an open source |
| 81 | +license. The procedure is simple: To certify above Developer's |
| 82 | +Certificate of Origin 1.1 for your contribution just append a line |
| 83 | + |
| 84 | +```text |
| 85 | +Signed-off-by: Random J Developer <[email protected]> |
| 86 | +``` |
| 87 | + |
| 88 | +to every commit message using your real name or your pseudonym and a valid |
| 89 | +email address. |
| 90 | + |
| 91 | +If you have set your `user.name` and `user.email` git configs you can |
| 92 | +automatically sign the commit by running the git-commit command with the |
| 93 | +`-s` option. There may be multiple sign-offs if more than one developer |
| 94 | +was involved in authoring the contribution. |
| 95 | + |
| 96 | +For a more detailed description of this procedure, please see |
| 97 | +[SubmittingPatches][] which was extracted from the Linux kernel project, |
| 98 | +and which is stored in an external repository. |
| 99 | + |
| 100 | +### Individual vs. Corporate Contributors |
| 101 | + |
| 102 | +Often employers or academic institution have ownership over code that is |
| 103 | +written in certain circumstances, so please do due diligence to ensure that |
| 104 | +you have the right to submit the code. |
| 105 | + |
| 106 | +If you are a developer who is authorized to contribute to RSU Connector on behalf of |
| 107 | +your employer, then please use your corporate email address in the |
| 108 | +Signed-off-by tag, otherwise use a personal email address. |
| 109 | + |
| 110 | +### Maintain Copyright holder / Contributor list |
| 111 | + |
| 112 | +Each contributor is responsible for identifying themselves in the NOTICE |
| 113 | +file, the project's list of copyright holders and authors. Please add |
| 114 | +the respective information corresponding to the Signed-off-by tag as |
| 115 | +part of your first pull request. |
| 116 | + |
| 117 | +If you are a developer who is authorized to contribute to RSU Connector on |
| 118 | +behalf of your employer, then add your company / organization to the |
| 119 | +list of copyright holders in the NOTICE file. As author of a corporate |
| 120 | +contribution you can also add your name and corporate email address as |
| 121 | +in the Signed-off-by tag. |
| 122 | + |
| 123 | +If your contribution is covered by this project's DCO's clause "(c) The |
| 124 | +contribution was provided directly to me by some other person who |
| 125 | +certified (a), (b) or (c) and I have not modified it", please add the |
| 126 | +appropriate copyright holder(s) to the NOTICE file as part of your |
| 127 | +contribution. |
| 128 | + |
| 129 | +[SubmittingPatches]: |
| 130 | +https://github.com/wking/signed-off-by/blob/7d71be37194df05c349157a2161c7534feaf86a4/Documentation/SubmittingPatches |
0 commit comments