diff options
| author | José Expósito <jose.exposito89@gmail.com> | 2024-02-28 16:59:58 +0100 |
|---|---|---|
| committer | José Expósito <jose.exposito89@gmail.com> | 2024-02-28 16:59:58 +0100 |
| commit | b5b825a7c314ef61087c2111f266a843b1ac5d91 (patch) | |
| tree | 2961322f10f0077b8cee0ffa1b87b8631738df9c | |
| parent | 399ba5e0ee5275567292f6c8e1ec05bbe888c007 (diff) | |
doc/user: Document "Closes" and "Fixes" tags
Describe how the tags should be used. The guidelines for the "Fixes"
tag are taken from the Linux kernel documentation [1][2].
[1] https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html#using-reported-by-tested-by-reviewed-by-suggested-by-and-fixes
[2] https://www.kernel.org/doc/html/v4.17/process/submitting-patches.html#describe-changes
Closes: #974
Signed-off-by: José Expósito <jose.exposito89@gmail.com>
Part-of: <https://gitlab.freedesktop.org/libinput/libinput/-/merge_requests/978>
| -rw-r--r-- | doc/user/contributing.rst | 11 |
1 files changed, 11 insertions, 0 deletions
diff --git a/doc/user/contributing.rst b/doc/user/contributing.rst index bbcc6f89..db83ba57 100644 --- a/doc/user/contributing.rst +++ b/doc/user/contributing.rst @@ -287,6 +287,17 @@ 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. +If your commit solves a GitLab issue, add a ``Closes:`` tag followed by the +issue number at the end of your commit message. For example: :: + + Closes: #974 + +If your commit fixes an issue introduced by another commit, use a ``Fixes`` tag +followed by the first 12 characters of the SHA-1 ID and the commit one line +summary at the end of your commit message. For example: :: + + Fixes: 123456789012 ("The commit that caused the issue") + 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. |