Commit 3bb381b0 authored by Dominique Barton's avatar Dominique Barton 🦄
Browse files

DOC: Update Git commit message guidelines

See also confirm/python-libraries/tools#19
parent a68b3483
Pipeline #15149 passed with stage
in 49 seconds
......@@ -104,13 +104,12 @@ Make sure you **prefix** your commit messages with one of the following prefixes
All allowed prefixes can be found in :data:`confirm.tools.git.PREFIXES`.
Subject
Summary
~~~~~~~
Please follow these rules for a good subject:
- Limit the **summary** (aka subject) to **50 characters**
- Limit the **description** (aka body) to **72 characters**
- **Capitalize** the sentence
- Do not end the sentence with a **period**, as it's unnecessary
- Use the **imperative** mood
......@@ -126,14 +125,16 @@ Please follow these rules for a good subject:
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!
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
~~~~
Also ensure you don't use identical summaries for multiple commits. You might want to squash them instead.
Please follow these rules for a good body:
Description
~~~~~~~~~~~
- Wrap the body at **72 characters**
Please follow these rules for a good description:
- Wrap the description (aka body) at **72 characters**
- Use it to describe the **what** and **why**
- Do not describe the **how**, as this describes the changeset itself
- Clearly mention any **related issue** numbers with the GitLab syntax (i.e. ``#…``)
......@@ -142,6 +143,6 @@ Please follow these rules for a good body:
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 only a subject line.
Some commits don't need a description and might be fine with only a summary 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