From ee51f3746a7ba16c93c5e84512ff1397cdf2e031 Mon Sep 17 00:00:00 2001 From: Brad King Date: Thu, 24 Aug 2017 09:58:45 -0400 Subject: Help/dev: Add commit reference format to review process guide --- Help/dev/review.rst | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) 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 (, )``, where: + +* ````: + If available, a tag-relative name of the commit produced by + ``git describe --contains ``. Otherwise, the first + 8-10 characters of the commit ````. + +* ````: + The first line of the commit message. + +* ````: + 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 ```` may be used. + Revising Commit Messages ^^^^^^^^^^^^^^^^^^^^^^^^ -- cgit v0.12