Skip to content

Commit 93140a3

Browse files
committed
add example of signed off commits
Signed-off-by: Sylvain Hellegouarch <[email protected]>
1 parent 0df7ee6 commit 93140a3

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

sources/reference/developing/guidelines.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,13 @@ high-level rules here:
5252
* One PR per functional change. Try to keep your PR focused
5353

5454
* A PR should always have the following:
55-
* Signed commits (as per the [DCO][dco]) to notify the project you are
56-
allowed to submit this code change
55+
* [Signed][signoff] commits (as per the [DCO][dco]) to notify the project you
56+
are allowed to submit this code change:
57+
58+
```bash
59+
git commit --signoff -m "...." -a
60+
```
61+
5762
* A `CHANGELOG` entry. Do not set the version or date on the entry
5863
* Tests wherever possible to control non-regression down the road and help
5964
with maintainance
@@ -84,6 +89,7 @@ high-level rules here:
8489
Python [json][] module
8590

8691

92+
[signoff]: https://git-scm.com/docs/git-commit#Documentation/git-commit.txt---signoff
8793
[dco]: https://developercertificate.org/
8894
[json]: https://docs.python.org/3/library/json.html#module-json
8995

0 commit comments

Comments
 (0)