Skip to content

Commit 5f37d94

Browse files
committed
doc: desc DCO process in CONTRIBUTING
Signed-off-by: Xavier Delaruelle <[email protected]>
1 parent b5e10be commit 5f37d94

File tree

3 files changed

+43
-0
lines changed

3 files changed

+43
-0
lines changed

.hunspell.en.dic

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1214,3 +1214,4 @@ TSC
12141214
coc
12151215
ov
12161216
readme
1217+
DCO

CONTRIBUTING.rst

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ Start coding
7878
* Include tests that cover any code changes you make. Make sure the test fails
7979
without your patch.
8080
* `Run the tests <running-the-tests_>`_ and `verify coverage <running-test-coverage_>`_.
81+
* `Sign-off your commits <developer-certificate-of-origin_>`_.
8182
* Push your commits to GitHub and `create a pull request`_.
8283

8384
.. _committing as you go: https://afraid-to-commit.readthedocs.io/en/latest/git/commandlinegit.html#commit-your-changes
@@ -234,6 +235,45 @@ Coding conventions
234235

235236
.. _Tcl minimal escaping style: https://wiki.tcl-lang.org/page/Tcl+Minimal+Escaping+Style
236237

238+
.. _developer-certificate-of-origin:
239+
240+
Developer Certificate of Origin (DCO)
241+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
242+
243+
In order to ensure that all contributions are properly authorized and in
244+
compliance with licensing requirements, Modules project follows the `Developer
245+
Certificate of Origin (DCO)`_ process. The DCO is a lightweight mechanism to
246+
certify that you, as a contributor, have the right to submit your code and
247+
agree to the project’s licensing terms.
248+
249+
How to sign off your commits
250+
""""""""""""""""""""""""""""
251+
252+
Every commit must include a ``Signed-off-by`` line, which certifies that the
253+
contribution adheres to the DCO. You can do this by adding the following line
254+
at the end of your commit message::
255+
256+
Signed-off-by: Your Name <[email protected]>
257+
258+
The name and email must match your Git configuration (``git config user.name``
259+
and ``git config user.email``).
260+
261+
To simplify the process, you can use the ``-s`` flag of ``git`` command when
262+
committing::
263+
264+
git commit -s -m "Your commit message"
265+
266+
Verifying DCO Compliance
267+
""""""""""""""""""""""""
268+
269+
Modules repository automates checks to enforce the DCO. If your contribution
270+
does not include the proper ``Signed-off-by`` line, the pull request check
271+
will fail. You will need to amend your commit::
272+
273+
git commit --amend -s
274+
275+
.. _Developer Certificate of Origin (DCO): https://developercertificate.org/
276+
237277
.. _commit-hooks:
238278

239279
Commit hooks

NEWS.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@ Modules 5.6.0 (not yet released)
3131
issue #565)
3232
* Doc: advertise the `Modules chat room`_ (``#modules:matrix.org``) to discuss
3333
with the community.
34+
* Doc: describe the :ref:`developer-certificate-of-origin` process now applied
35+
on contributions.
3436

3537
.. _Security policy: https://github.com/envmodules/modules/blob/main/SECURITY.md
3638
.. _Modules chat room: https://matrix.to/#/#modules:matrix.org

0 commit comments

Comments
 (0)