summaryrefslogtreecommitdiffstats
path: root/Help
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-08-24 13:52:59 (GMT)
committerBrad King <brad.king@kitware.com>2017-08-24 13:52:59 (GMT)
commitc928439c234f48afaccdf211e76124b0ff918c17 (patch)
treec1bb0df17359d5634d3f98f36cf86a5ec6d69956 /Help
parentc7c639f2f363b6918ac13daea214cea56035e0aa (diff)
downloadCMake-c928439c234f48afaccdf211e76124b0ff918c17.zip
CMake-c928439c234f48afaccdf211e76124b0ff918c17.tar.gz
CMake-c928439c234f48afaccdf211e76124b0ff918c17.tar.bz2
Help/dev: Organize commit message instructions into subsections
Diffstat (limited to 'Help')
-rw-r--r--Help/dev/review.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index 985b1b7..2a636c7 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -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
information.
+Area Prefix on Commit Messages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
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
human reviewer to confirm that the area is specified and that it is
@@ -209,6 +212,9 @@ message include:
* ``Autogen: Extended mocInclude tests``
* ``cmLocalGenerator: Explain standard flag selection logic in comments``
+Referencing Issues in Commit Messages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
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
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
above, but committers should aim for this format for consistency. Note that
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
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