diff options
| author | William Brown <william@blackhats.net.au> | 2020-01-29 13:32:03 +1000 |
|---|---|---|
| committer | William Brown <william@blackhats.net.au> | 2020-01-29 13:32:55 +1000 |
| commit | 63ac196def91cd97d86a4e8820d67659f233ce20 (patch) | |
| tree | 13a6280a35806cb5e38c2bbee35d6ef0217a3aff | |
| parent | e5a6200a8eb7fe1b473084b559080d46d2046c90 (diff) | |
| download | libinput-63ac196def91cd97d86a4e8820d67659f233ce20.tar.gz | |
Improve git commit section
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>
| -rw-r--r-- | doc/user/contributing.rst | 22 |
1 files changed, 16 insertions, 6 deletions
diff --git a/doc/user/contributing.rst b/doc/user/contributing.rst index 28fe3ce0..5272f448 100644 --- a/doc/user/contributing.rst +++ b/doc/user/contributing.rst @@ -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: :: + + A description of this commit, and it's great work. + + Signed-off-by: Claire Someone <name@domain> -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 +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 ------------------------------------------------------------------------------ |