Skip to content

Commit

Permalink
doc: desc DCO process in CONTRIBUTING
Browse files Browse the repository at this point in the history
Signed-off-by: Xavier Delaruelle <xavier.delaruelle@cea.fr>
  • Loading branch information
xdelaruelle committed Feb 2, 2025
1 parent b5e10be commit 5f37d94
Show file tree
Hide file tree
Showing 3 changed files with 43 additions and 0 deletions.
1 change: 1 addition & 0 deletions .hunspell.en.dic
Original file line number Diff line number Diff line change
Expand Up @@ -1214,3 +1214,4 @@ TSC
coc
ov
readme
DCO
40 changes: 40 additions & 0 deletions CONTRIBUTING.rst
Original file line number Diff line number Diff line change
Expand Up @@ -78,6 +78,7 @@ Start coding
* Include tests that cover any code changes you make. Make sure the test fails
without your patch.
* `Run the tests <running-the-tests_>`_ and `verify coverage <running-test-coverage_>`_.
* `Sign-off your commits <developer-certificate-of-origin_>`_.
* Push your commits to GitHub and `create a pull request`_.

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

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

.. _developer-certificate-of-origin:

Developer Certificate of Origin (DCO)
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

In order to ensure that all contributions are properly authorized and in
compliance with licensing requirements, Modules project follows the `Developer
Certificate of Origin (DCO)`_ process. The DCO is a lightweight mechanism to
certify that you, as a contributor, have the right to submit your code and
agree to the project’s licensing terms.

How to sign off your commits
""""""""""""""""""""""""""""

Every commit must include a ``Signed-off-by`` line, which certifies that the
contribution adheres to the DCO. You can do this by adding the following line
at the end of your commit message::

Signed-off-by: Your Name <your.email@example.com>

The name and email must match your Git configuration (``git config user.name``
and ``git config user.email``).

To simplify the process, you can use the ``-s`` flag of ``git`` command when
committing::

git commit -s -m "Your commit message"

Verifying DCO Compliance
""""""""""""""""""""""""

Modules repository automates checks to enforce the DCO. If your contribution
does not include the proper ``Signed-off-by`` line, the pull request check
will fail. You will need to amend your commit::

git commit --amend -s

.. _Developer Certificate of Origin (DCO): https://developercertificate.org/

.. _commit-hooks:

Commit hooks
Expand Down
2 changes: 2 additions & 0 deletions NEWS.rst
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ Modules 5.6.0 (not yet released)
issue #565)
* Doc: advertise the `Modules chat room`_ (``#modules:matrix.org``) to discuss
with the community.
* Doc: describe the :ref:`developer-certificate-of-origin` process now applied
on contributions.

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

0 comments on commit 5f37d94

Please sign in to comment.