Commit 33902d25 authored by Dominique Barton's avatar Dominique Barton 🦄
Browse files

DOC: Add Git changelog highlight words

parent 292ba7a8
Pipeline #11364 passed with stage
in 31 seconds
......@@ -100,6 +100,10 @@ Make sure you **prefix** your commit messages with one of the following prefixes
- ``MISC: Add SPAM to .gitignore``
- ``REVERT: Reverted the SPAM commit``
.. hint::
All allowed prefixes can be found in :data:`confirm.tools.git.PREFIXES`.
Subject
~~~~~~~
......@@ -120,6 +124,8 @@ Please follow these rules for a good subject:
.. important::
We're automatically generating the :ref:`tools:Git Changelog` from Git commit messages.
Always use **proper commit messages**. Commit messages must be meaningful and short at the same time. Things like ``changed some files``, ``update`` or ``fix`` are not proper commit messages and you'll burn in hell for it!
Body
......@@ -132,6 +138,10 @@ Please follow these rules for a good body:
- Do not describe the **how**, as this describes the changeset itself
- Clearly mention any **related issue** numbers with the GitLab syntax (i.e. ``#…``)
.. hint::
.. important::
We're automatically generating the :ref:`tools:Git Changelog` from Git commit messages.
Some commits don't need a body and might be fine with a single subject line.
Some commits don't need a body and might be fine with only a subject line.
However, if a commit (message) requires **special attention**, make sure you're using a
:data:`highlight word <confirm.tools.git.HIGHLIGHT_WORDS>` in the commit message.
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment