summaryrefslogtreecommitdiffstats
path: root/Help/dev
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-08-24 13:58:45 (GMT)
committerBrad King <brad.king@kitware.com>2017-08-29 17:01:47 (GMT)
commitee51f3746a7ba16c93c5e84512ff1397cdf2e031 (patch)
tree855d0e9f8c3669a65beca158eef4cb35d58253e5 /Help/dev
parentc928439c234f48afaccdf211e76124b0ff918c17 (diff)
downloadCMake-ee51f3746a7ba16c93c5e84512ff1397cdf2e031.zip
CMake-ee51f3746a7ba16c93c5e84512ff1397cdf2e031.tar.gz
CMake-ee51f3746a7ba16c93c5e84512ff1397cdf2e031.tar.bz2
Help/dev: Add commit reference format to review process guide
Diffstat (limited to 'Help/dev')
-rw-r--r--Help/dev/review.rst20
1 files changed, 20 insertions, 0 deletions
diff --git a/Help/dev/review.rst b/Help/dev/review.rst
index 2a636c7..be02a1a 100644
--- a/Help/dev/review.rst
+++ b/Help/dev/review.rst
@@ -234,6 +234,26 @@ 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.
+Referencing Commits in Commit Messages
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+
+The preferred form for references to other commits is
+``commit <commit> (<subject>, <date>)``, where:
+
+* ``<commit>``:
+ If available, a tag-relative name of the commit produced by
+ ``git describe --contains <commit-ish>``. Otherwise, the first
+ 8-10 characters of the commit ``<hash>``.
+
+* ``<subject>``:
+ The first line of the commit message.
+
+* ``<date>``:
+ The author date of the commit, in its original time zone, formatted as
+ ``CCYY-MM-DD``. ``git-log(1)`` shows the original time zone by default.
+
+Alternatively, the full commit ``<hash>`` may be used.
+
Revising Commit Messages
^^^^^^^^^^^^^^^^^^^^^^^^