diff --git a/Help/dev/review.rst b/Help/dev/review.rst index 0c4ededd61..1d664c4b82 100644 --- a/Help/dev/review.rst +++ b/Help/dev/review.rst @@ -238,12 +238,10 @@ Referencing Commits in Commit Messages ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ The preferred form for references to other commits is -``commit (, )``, where: +``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 abbreviated hash of the commit. * ````: The first line of the commit message. @@ -252,6 +250,17 @@ The preferred form for references to other commits is 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. +This may be generated with +``git show -s --date=short --pretty="format:%h (%s, %ad)" ``. + +If the commit is a fix for the mentioned commit, consider using a ``Fixes:`` +trailer in the commit message with the specified format. This trailer should +not be word-wrapped. Note that if there is also an issue for what is being +fixed, it is preferrable to link to the issue instead. + +If relevant, add the first release tag of CMake containing the commit after +the ````, i.e., ``commit (, , )``. + Alternatively, the full commit ```` may be used. Revising Commit Messages