mirror/CMake
1
0
Fork 0
mirror of https://github.com/Kitware/CMake.git synced 2026-01-04 04:40:56 -06:00
Code Issues Packages Projects Releases Wiki Activity

Help/dev: Add commit reference format to review process guide

Browse Source
This commit is contained in:
Brad King
2017-08-24 09:58:45 -04:00
parent c928439c23
commit ee51f3746a
1 changed files with 20 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

20
Help/dev/review.rst
View File

@@ -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 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.
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 Revising Commit Messages
^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^