Commit c928439c authored by Brad King's avatar Brad King
Browse files

Help/dev: Organize commit message instructions into subsections

parent c7c639f2
...@@ -195,6 +195,9 @@ Committers should aim to keep this first line short. Any subsequent lines ...@@ -195,6 +195,9 @@ Committers should aim to keep this first line short. Any subsequent lines
should be separated from the first by a blank line and provide relevant, useful should be separated from the first by a blank line and provide relevant, useful
information. information.
Area Prefix on Commit Messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
The appropriateness of the initial word describing the area the commit applies The appropriateness of the initial word describing the area the commit applies
to is not something the automatic robot review can judge, so it is up to the to is not something the automatic robot review can judge, so it is up to the
human reviewer to confirm that the area is specified and that it is human reviewer to confirm that the area is specified and that it is
...@@ -209,6 +212,9 @@ message include: ...@@ -209,6 +212,9 @@ message include:
* ``Autogen: Extended mocInclude tests`` * ``Autogen: Extended mocInclude tests``
* ``cmLocalGenerator: Explain standard flag selection logic in comments`` * ``cmLocalGenerator: Explain standard flag selection logic in comments``
Referencing Issues in Commit Messages
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
If the commit fixes a particular reported issue, this information should If the commit fixes a particular reported issue, this information should
ideally also be part of the commit message. The recommended way to do this is ideally also be part of the commit message. The recommended way to do this is
to place a line at the end of the message in the form ``Fixes: #xxxxx`` where to place a line at the end of the message in the form ``Fixes: #xxxxx`` where
...@@ -228,6 +234,9 @@ other synonyms for ``Fixes`` and allows much more flexible forms than the ...@@ -228,6 +234,9 @@ other synonyms for ``Fixes`` and allows much more flexible forms than the
above, but committers should aim for this format for consistency. Note that above, but committers should aim for this format for consistency. Note that
such details can alternatively be specified in the merge request description. such details can alternatively be specified in the merge request description.
Revising Commit Messages
^^^^^^^^^^^^^^^^^^^^^^^^
Reviewers are encouraged to ask the committer to amend commit messages to Reviewers are encouraged to ask the committer to amend commit messages to
follow these guidelines, but prefer to focus on the changes themselves as a follow these guidelines, but prefer to focus on the changes themselves as a
first priority. Maintainers will also make a check of commit messages before first priority. Maintainers will also make a check of commit messages before
......
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