You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: CONTRIBUTING.md
+10-4Lines changed: 10 additions & 4 deletions
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ This project welcomes contributions. Most contributions require you to signoff o
4
4
the Developer Certificate of Origin (DCO). When you submit a pull request, a DCO-bot will automatically determine
5
5
whether you need to provide signoff for your commit. Please follow the instructions provided by DCO-bot, as pull
6
6
requests cannot be merged until the author(s) have provided signoff to fulfill the DCO requirement.
7
-
You may find more information on the DCO requirements [below](#developer-certificate-of-origin-signing-your-work).
7
+
You may find more information on the DCO requirements [below](#developer-certificate-of-origin-and-gpg-signing).
8
8
9
9
## Issues
10
10
@@ -31,7 +31,7 @@ All contributions come through pull requests. To submit a proposed change, we re
31
31
- Code changes require tests
32
32
- Make sure to run the linters to check and format the code
33
33
4. Update relevant documentation for the change
34
-
5. Commit with [DCO sign-off](#developer-certificate-of-origin-signing-your-work) and open a PR
34
+
5. Commit with [DCO sign-off](#developer-certificate-of-origin-and-gpg-signing) and open a PR
35
35
6. Wait for the CI process to finish and make sure all checks are green
36
36
7. A maintainer of the project will be assigned, and you can expect a review within a few days
37
37
@@ -51,7 +51,8 @@ This project requires two types of signatures on all commits:
51
51
**For DCO Sign-offs:**
52
52
53
53
The Developer Certificate of Origin (DCO) is a lightweight way for contributors to certify that they wrote or otherwise have the right to submit the code they are contributing to the project. Here is the full text of the [DCO](https://developercertificate.org/), reformatted for readability:
54
-
```
54
+
55
+
```text
55
56
By making a contribution to this project, I certify that:
56
57
57
58
(a) The contribution was created in whole or in part by me and I have the right to submit it under the open source license indicated in the file; or
@@ -82,17 +83,20 @@ git commit -s -m 'This is my commit message'
82
83
GPG signatures verify the identity of the committer. To set up GPG signing:
83
84
84
85
1. Generate a GPG key and configure Git to use it:
86
+
85
87
```sh
86
88
git config --global user.signingkey YOUR_KEY_ID
87
89
git config --global commit.gpgsign true
88
90
```
89
91
90
92
2. Sign commits with the `-S` flag (or rely on the automatic signing from the above configuration):
93
+
91
94
```sh
92
95
git commit -S -m 'This is my signed commit message'
93
96
```
94
97
95
98
3. For both DCO sign-off and GPG signature in one command:
99
+
96
100
```sh
97
101
git commit -S -s -m 'This is my signed and signed-off commit message'
98
102
```
@@ -101,18 +105,20 @@ For detailed instructions on setting up both signature types, see [docs/commit-s
101
105
102
106
Each Pull Request is checked to ensure all commits contain valid DCO sign-offs and GPG signatures.
103
107
104
-
#### I didn't sign my commit, now what?!
108
+
#### I didn't sign my commit, now what?
105
109
106
110
No worries - You can easily replay your changes, sign them and force push them!
107
111
108
112
**For adding both DCO sign-off and GPG signature:**
0 commit comments