[Cmake-commits] CMake branch, master, updated. v3.9.1-635-g54efb7e
Kitware Robot
kwrobot at kitware.com
Wed Aug 30 08:35:05 EDT 2017
This is an automated email from the git hooks/post-receive script. It was
generated because a ref change was pushed to the repository containing
the project "CMake".
The branch, master has been updated
via 54efb7e07a7d6497638c8ea5247b546d0575c55e (commit)
via ee51f3746a7ba16c93c5e84512ff1397cdf2e031 (commit)
via c928439c234f48afaccdf211e76124b0ff918c17 (commit)
from 7321cfb667ce2907dbc0716f6a26ac64106c7eb9 (commit)
Those revisions listed above that are new to this repository have
not appeared on any other notification email; so we list those
revisions in full, below.
- Log -----------------------------------------------------------------
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=54efb7e07a7d6497638c8ea5247b546d0575c55e
commit 54efb7e07a7d6497638c8ea5247b546d0575c55e
Merge: 7321cfb ee51f37
Author: Craig Scott <craig.scott at crascit.com>
AuthorDate: Wed Aug 30 12:30:44 2017 +0000
Commit: Kitware Robot <kwrobot at kitware.com>
CommitDate: Wed Aug 30 08:33:00 2017 -0400
Merge topic 'doc-dev-review-messages'
ee51f374 Help/dev: Add commit reference format to review process guide
c928439c Help/dev: Organize commit message instructions into subsections
Acked-by: Kitware Robot <kwrobot at kitware.com>
Merge-request: !1182
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=ee51f3746a7ba16c93c5e84512ff1397cdf2e031
commit ee51f3746a7ba16c93c5e84512ff1397cdf2e031
Author: Brad King <brad.king at kitware.com>
AuthorDate: Thu Aug 24 09:58:45 2017 -0400
Commit: Brad King <brad.king at kitware.com>
CommitDate: Tue Aug 29 13:01:47 2017 -0400
Help/dev: Add commit reference format to review process guide
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
^^^^^^^^^^^^^^^^^^^^^^^^
https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=c928439c234f48afaccdf211e76124b0ff918c17
commit c928439c234f48afaccdf211e76124b0ff918c17
Author: Brad King <brad.king at kitware.com>
AuthorDate: Thu Aug 24 09:52:59 2017 -0400
Commit: Brad King <brad.king at kitware.com>
CommitDate: Thu Aug 24 09:52:59 2017 -0400
Help/dev: Organize commit message instructions into subsections
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
-----------------------------------------------------------------------
Summary of changes:
Help/dev/review.rst | 29 +++++++++++++++++++++++++++++
1 file changed, 29 insertions(+)
hooks/post-receive
--
CMake
More information about the Cmake-commits
mailing list