Skip to content

Commit 8c24e08

Browse files
committed
docs: add a few notes about contributing to OMPI
Signed-off-by: Jeff Squyres <jsquyres@cisco.com>
1 parent c74dfde commit 8c24e08

File tree

1 file changed

+21
-6
lines changed

1 file changed

+21
-6
lines changed

docs/contributing.rst

Lines changed: 21 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -105,9 +105,18 @@ process as described in Section 11 of the Linux kernel document on
105105
<https://www.kernel.org/doc/html/latest/process/submitting-patches.html#sign-your-work-the-developer-s-certificate-of-origin>`_.
106106
Each proposed contribution to the Open MPI code base must include the
107107
text ``Signed-off-by:`` followed by the contributor's name and email
108-
address. This is a developer's certification that he or she has the
109-
right to submit the patch for inclusion into the project, and
110-
indicates agreement to the Developer's Certificate of Origin:
108+
address.
109+
110+
.. admonition:: Pro tip
111+
:class: tip
112+
113+
You can use the ``-s`` flag to the ``git commit`` command (i.e.,
114+
``git commit -s ...``) to automatically add the appropriate
115+
``Signed-off-by:`` line to your commit message.
116+
117+
The ``Signed-off-by:`` line is a developer's certification that he or
118+
she has the right to submit the patch for inclusion into the project,
119+
and indicates agreement to the Developer's Certificate of Origin:
111120

112121
By making a contribution to this project, I certify that:
113122

@@ -145,12 +154,18 @@ inadvertently made without the required certification.
145154
If you have not already done so, please ensure that *every* commit in
146155
your pull request contains the ``Signed-off-by:`` line.
147156

157+
Git commit messages
158+
^^^^^^^^^^^^^^^^^^^
159+
160+
Please write a good Git commit message, with a short first line
161+
describing *what* was done, and then a description of *why* it was
162+
done.
163+
148164
.. admonition:: Pro tip
149165
:class: tip
150166

151-
You can use the ``-s`` flag to the ``git commit`` command (i.e.,
152-
``git commit -s ...``) to automatically add the appropriate
153-
``Signed-off-by:`` line to your commit message.
167+
`See this blog entry <https://cbea.ms/git-commit/>`_ for an
168+
excellent description of how to write a good Git commit message.
154169

155170
Code style
156171
^^^^^^^^^^

0 commit comments

Comments
 (0)