fdo-mirrors/libinput
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/libinput/libinput.git synced 2026-02-03 20:30:27 +01:00
Code Issues Projects Releases Packages Wiki Activity Actions

Improve git commit section

Browse source 
It wasn't clear about the Signed-of-by requirements, so this has been
improved with an example, and clarifies that it is a requirement, not
optional.

Signed-off-by: William Brown <william@blackhats.net.au>
This commit is contained in:
William Brown 2020-01-29 13:32:03 +10:00
parent e5a6200a8e
commit 63ac196def
1 changed files with 16 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
doc/user/contributing.rst
View file

@ -219,18 +219,24 @@ same file(s) as the patch being sent.
Commit Messages
------------------------------------------------------------------------------
Read `on commit messages <http://who-t.blogspot.de/2009/12/on-commit-messages.html>`_
as a general guideline on what commit messages should contain.
Commit messages **must** contain a **Signed-off-by** line with your name
and email address. An example is: ::
Commit messages **should** contain a **Signed-off-by** line with your name
and email address. If you're not the patch's original author, you should
A description of this commit, and it's great work.
Signed-off-by: Claire Someone <name@domain>
If you're not the patch's original author, you should
also gather S-o-b's by them (and/or whomever gave the patch to you.) The
significance of this is that it certifies that you created the patch, that
it was created under an appropriate open source license, or provided to you
under those terms. This lets us indicate a chain of responsibility for the
copyright status of the code.
copyright status of the code. An example is: ::
We won't reject patches that lack S-o-b, but it is strongly recommended.
A description of this commit, and it's great work.
Signed-off-by: Claire Someone <name@domain>
Signed-off-by: Ferris Crab <name@domain>
When you re-send patches, revised or not, it would be very good to document the
changes compared to the previous revision in the commit message and/or the
@ -239,6 +245,10 @@ should evaluate whether they still apply and include them in the respective
commit messages. Otherwise the tags may be lost, reviewers miss the credit they
deserve, and the patches may cause redundant review effort.
For further reading, please see
`'on commit messages' <http://who-t.blogspot.de/2009/12/on-commit-messages.html>`_
as a general guideline on what commit messages should contain.
------------------------------------------------------------------------------
Coding Style
------------------------------------------------------------------------------