Skip to content

Commit a049846

Browse files
committed
add DCO section for signing commits
Add a section describing DCO / commit signing, exactly the same info as we already have on firectl repo to keep things consistent. Signed-off-by: Gavin Inglis <[email protected]>
1 parent 570d5fe commit a049846

File tree

1 file changed

+58
-2
lines changed

1 file changed

+58
-2
lines changed

CONTRIBUTING.md

Lines changed: 58 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,8 +33,9 @@ To send us a pull request, please:
3333
2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
3434
3. Ensure local tests pass.
3535
4. Commit to your fork using clear commit messages.
36-
5. Send us a pull request, answering any default questions in the pull request interface.
37-
6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
36+
5. Verify all commit messages include [DCO signature](#sign-your-work)
37+
6. Send us a pull request, answering any default questions in the pull request interface.
38+
7. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
3839

3940
GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
4041
[creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
@@ -50,6 +51,61 @@ For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of
5051
[email protected] with any additional questions or comments.
5152

5253

54+
## Sign your work
55+
56+
The sign-off is a simple line at the end of the explanation for the patch. Your
57+
signature certifies that you wrote the patch or otherwise have the right to pass
58+
it on as an open-source patch. If you can certify
59+
the below (from [developercertificate.org](http://developercertificate.org/)):
60+
61+
```
62+
Developer Certificate of Origin
63+
Version 1.1
64+
65+
Copyright (C) 2004, 2006 The Linux Foundation and its contributors.
66+
660 York Street, Suite 102,
67+
San Francisco, CA 94110 USA
68+
69+
Everyone is permitted to copy and distribute verbatim copies of this
70+
license document, but changing it is not allowed.
71+
72+
Developer's Certificate of Origin 1.1
73+
74+
By making a contribution to this project, I certify that:
75+
76+
(a) The contribution was created in whole or in part by me and I
77+
have the right to submit it under the open source license
78+
indicated in the file; or
79+
80+
(b) The contribution is based upon previous work that, to the best
81+
of my knowledge, is covered under an appropriate open source
82+
license and I have the right under that license to submit that
83+
work with modifications, whether created in whole or in part
84+
by me, under the same open source license (unless I am
85+
permitted to submit under a different license), as indicated
86+
in the file; or
87+
88+
(c) The contribution was provided directly to me by some other
89+
person who certified (a), (b) or (c) and I have not modified
90+
it.
91+
92+
(d) I understand and agree that this project and the contribution
93+
are public and that a record of the contribution (including all
94+
personal information I submit with it, including my sign-off) is
95+
maintained indefinitely and may be redistributed consistent with
96+
this project or the open source license(s) involved.
97+
```
98+
99+
Then you just add a line to every git commit message:
100+
101+
Signed-off-by: Joe Smith <[email protected]>
102+
103+
Use your real name (sorry, no pseudonyms or anonymous contributions.)
104+
105+
If you set your `user.name` and `user.email` git configs, you can sign your
106+
commit automatically with `git commit -s`.
107+
108+
53109
## Security issue notifications
54110
If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
55111

0 commit comments

Comments
 (0)