|
| 1 | +# Contributing Guide |
| 2 | + |
| 3 | +Thanks for taking interest to contributing to our project! |
| 4 | + |
| 5 | +## Pull Requests |
| 6 | +Prior to making a PR, we ask you to communicate it with us, preferably by opening an issue. |
| 7 | +This would help to keep your work aligned with the maintainers view and get insights from |
| 8 | +them. |
| 9 | + |
| 10 | +All commits are required to be signed via verified GPG key. You can read about commit signing |
| 11 | +in [this series of articles](https://docs.github.com/en/authentication/managing-commit-signature-verification) |
| 12 | +(we recommend using a hardware GPG token). |
| 13 | + |
| 14 | +All commits are required to be signed off by including `Signed-off-by: YOUR NAME <your_email@example.com>` line. |
| 15 | +By doing this, you certify that the commit is compliant with [Developer Certificate of Origin (DCO)](https://developercertificate.org/), |
| 16 | +meaning that you wrote the code or otherwise have the right to submit the code you are |
| 17 | +contributing to the project. |
| 18 | + |
| 19 | +```text |
| 20 | +Developer Certificate of Origin |
| 21 | +Version 1.1 |
| 22 | +
|
| 23 | +Copyright (C) 2004, 2006 The Linux Foundation and its contributors. |
| 24 | +
|
| 25 | +Everyone is permitted to copy and distribute verbatim copies of this |
| 26 | +license document, but changing it is not allowed. |
| 27 | +
|
| 28 | +
|
| 29 | +Developer's Certificate of Origin 1.1 |
| 30 | +
|
| 31 | +By making a contribution to this project, I certify that: |
| 32 | +
|
| 33 | +(a) The contribution was created in whole or in part by me and I |
| 34 | + have the right to submit it under the open source license |
| 35 | + indicated in the file; or |
| 36 | +
|
| 37 | +(b) The contribution is based upon previous work that, to the best |
| 38 | + of my knowledge, is covered under an appropriate open source |
| 39 | + license and I have the right under that license to submit that |
| 40 | + work with modifications, whether created in whole or in part |
| 41 | + by me, under the same open source license (unless I am |
| 42 | + permitted to submit under a different license), as indicated |
| 43 | + in the file; or |
| 44 | +
|
| 45 | +(c) The contribution was provided directly to me by some other |
| 46 | + person who certified (a), (b) or (c) and I have not modified |
| 47 | + it. |
| 48 | +
|
| 49 | +(d) I understand and agree that this project and the contribution |
| 50 | + are public and that a record of the contribution (including all |
| 51 | + personal information I submit with it, including my sign-off) is |
| 52 | + maintained indefinitely and may be redistributed consistent with |
| 53 | + this project or the open source license(s) involved. |
| 54 | +``` |
| 55 | + |
| 56 | +Commits can be automatically signed off automatically by using `-s` flag (i.e. `git commit -s`). |
| 57 | + |
| 58 | +## Issues |
| 59 | +Feel free to open an issue if you found a bug, have a suggestion, or wish to |
| 60 | +communicate with us for other reasons. |
| 61 | + |
| 62 | +However, if you want to report something that you believe might be a security |
| 63 | +vulnerability or a security flaw in this or any upstream project, please report |
| 64 | +it following the procedure described in [SECURITY.md](./SECURITY.md). |
0 commit comments