documentation: update commit message template

Co-Authored-by: Igor Milhit <[email protected]>

Author: Igor Milhit

.gitmessage.txt

@@ -1,6 +1,17 @@
-component: title without verbs (less than 50 chars)
+# the title begins with a verb, imperative mode
+# no trailing dot
+component: summarize changes in 50 char or less
 
-* NEW Adds your new feature.
-* FIX Fixes an existing issue, may closes #issue.
-* BETTER Improves and existing feature.
-* Changes something that should not be visible in release notes.
+# Focus on why you are making this change as opposed to how (the code
+# explains that).
+# Wrap line at 72 characters. Bullet points list is better, but full
+# paragraphs are possible too.
+* Adds your new feature.
+* Fixes an existing issue, may closes #issue.
+* Improves and existing feature.
+
+# No `Signed-off-by` line anymore.
+# Multiple `Co-Authored-by` lines are allowed.
+Co-Authored-by: [Your Full Name] <[your-email]>
+
+# https://github.com/inveniosoftware/invenio/blob/master/CONTRIBUTING.rst#commit-messages

CONTRIBUTING.rst

@@ -76,9 +76,9 @@ If you are proposing a feature:
 Get Started!
 ------------
 
-Ready to contribute? Here's how to set up `rero-ils` for local development.
+Ready to contribute? Here's how to set up ``rero-ils`` for local development.
 
-1. Fork the `rero/rero-ils` repo on GitHub.
+1. Fork the ``rero/rero-ils`` repo on GitHub.
 2. Clone your fork locally:
 
    .. code-block:: console
@@ -105,28 +105,26 @@ Ready to contribute? Here's how to set up `rero-ils` for local development.
    (code style), PEP257 (documentation), flake8 as well as build the Sphinx
    documentation and run doctests.
 
-6. Add the `.gitmessage.txt` to your `git` configuration:
+6. Add the ``.gitmessage.txt`` file to your ``git`` configuration:
 
-    .. code-block::console
+   .. code-block:: console
 
         # globally
         $ git config --global commit.template /path/.gitmessage.txt
 
         # locally
         $ git config --local commit.template .gitmessage.txt
 
+   The ``Signed-off-by`` message is not used anymore, so you can avoid ``-s``
+   parameters when committing. But of course, you can modify your own version
+   of the ``.gitcommit.txt`` in order to add you own ``Co-Authored-by`` message.
 
 7. Commit your changes and push your branch to GitHub:
 
    .. code-block:: console
 
       $ git add .
       $ git commit -s
-          -m "component: title without verbs"
-          -m "* NEW Adds your new feature."
-          -m "* FIX Fixes an existing issue."
-          -m "* BETTER Improves and existing feature."
-          -m "* Changes something that should not be visible in release notes."
       $ git push origin name-of-your-bugfix-or-feature
 
 8. Submit a pull request through the GitHub website.