Skip to content

Commit 20e46fa

Browse files
committed
Improve contributing guide by adding a section on signing off commits
related: #16957 closes: #16976 Signed-off-by: Christian Brabandt <[email protected]>
1 parent 7746348 commit 20e46fa

1 file changed

Lines changed: 26 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,31 @@ Contributions will be distributed with Vim under the Vim license. Providing a
2121
change to be included implies that you agree with this and your contribution
2222
does not cause us trouble with trademarks or patents. There is no CLA to sign.
2323

24+
## Signing-off commits
25+
26+
While not required, it's recommended to use **Signed-off commits** to ensure
27+
transparency, accountability, and compliance with open-source best practices.
28+
Signed-off commits follow the [Developer Certificate of Origin (DCO)][15],
29+
which confirms that contributors have the right to submit their changes under
30+
the project's license. This process adds a `Signed-off-by` line to commit
31+
messages, verifying that the contributor agrees to the project's licensing
32+
terms. To sign off a commit, simply use the -s flag when committing:
33+
34+
```sh
35+
git commit -s
36+
```
37+
38+
This ensures that every contribution is properly documented and traceable,
39+
aligning with industry standards used in projects like the Linux Kernel or
40+
the git project. By making Signed-off commits a standard practice, we help
41+
maintain a legally compliant and well-governed codebase while fostering trust
42+
within our contributor community.
43+
44+
When merging PRs into Vim, the current maintainer @chrisbra usually adds missing
45+
`Signed-off-by` trailers for the author user name and email address as well for
46+
anybody that explicitly *ACK*s a pull request as a statement that those
47+
approvers are happy with that particular change.
48+
2449
# Reporting issues
2550

2651
We use GitHub issues, but that is not a requirement. Writing to the Vim
@@ -113,3 +138,4 @@ mailing list. For other questions please use the [Vi Stack Exchange][8] website,
113138
[12]: https://github.com/vim/vim/blob/master/src/testdir/test_filetype.vim
114139
[13]: https://github.com/vim/vim/blob/master/runtime/doc/filetype.txt
115140
[14]: https://github.com/vim/vim/blob/master/runtime/doc/syntax.txt
141+
[15]: https://en.wikipedia.org/wiki/Developer_Certificate_of_Origin

0 commit comments

Comments
 (0)