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 14b2f85cd411ee9d7e19a28d5e2ea7958ab845ee (commit) via 11d00a17aafb33385a57a11b53862ac2197f116f (commit) from a7e95f737d9986e9ccea1229d925d7036ba4421f (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=14b2f85cd411ee9d7e19a28d5e2ea7958ab845ee commit 14b2f85cd411ee9d7e19a28d5e2ea7958ab845ee Merge: a7e95f7 11d00a1 Author: Brad King <brad.k...@kitware.com> AuthorDate: Thu Aug 10 15:07:42 2017 +0000 Commit: Kitware Robot <kwro...@kitware.com> CommitDate: Thu Aug 10 11:07:46 2017 -0400 Merge topic 'commit_message_guidelines' 11d00a17 Help/dev: Add commit message guidelines Acked-by: Kitware Robot <kwro...@kitware.com> Merge-request: !1106 https://cmake.org/gitweb?p=cmake.git;a=commitdiff;h=11d00a17aafb33385a57a11b53862ac2197f116f commit 11d00a17aafb33385a57a11b53862ac2197f116f Author: Craig Scott <craig.sc...@crascit.com> AuthorDate: Sat Aug 5 20:55:49 2017 +1000 Commit: Craig Scott <craig.sc...@crascit.com> CommitDate: Tue Aug 8 21:17:32 2017 +1000 Help/dev: Add commit message guidelines diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 3c84c2b..381769d 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -29,7 +29,8 @@ To contribute patches: #. Base all new work on the upstream ``master`` branch. Base work on the upstream ``release`` branch only if it fixes a regression or bug in a feature new to that release. -#. Create commits making incremental, distinct, logically complete changes. +#. Create commits making incremental, distinct, logically complete changes + with appropriate `commit messages`_. #. Push a topic branch to a personal repository fork on GitLab. #. Create a GitLab Merge Request targeting the upstream ``master`` branch (even if the change is intended for merge to the ``release`` branch). @@ -40,6 +41,7 @@ The merge request will enter the `CMake Review Process`_ for consideration. .. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake .. _`Utilities/SetupForDevelopment.sh`: Utilities/SetupForDevelopment.sh .. _`CMake Source Code Guide`: Help/dev/source.rst +.. _`commit messages`: Help/dev/review.rst#commit-messages .. _`CMake Review Process`: Help/dev/review.rst License diff --git a/Help/dev/review.rst b/Help/dev/review.rst index 9450bf0..985b1b7 100644 --- a/Help/dev/review.rst +++ b/Help/dev/review.rst @@ -185,6 +185,54 @@ commands to ``@kwrobot`` using the form ``Do: ...``: See the corresponding sections for details on permissions and options for each command. +Commit Messages +--------------- + +Part of the human review is to check that each commit message is appropriate. +The first line of the message should begin with one or two words indicating the +area the commit applies to, followed by a colon and then a brief summary. +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. + +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 +appropriate. Good area words include the module name the commit is primarily +fixing, the main C++ source file being edited, ``Help`` for generic +documentation changes or a feature or functionality theme the changes apply to +(e.g. ``server`` or ``Autogen``). Examples of suitable first lines of a commit +message include: + +* ``Help: Fix example in cmake-buildsystem(7) manual`` +* ``FindBoost: Add support for 1.64`` +* ``Autogen: Extended mocInclude tests`` +* ``cmLocalGenerator: Explain standard flag selection logic in comments`` + +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 +``xxxxx`` is the GitLab issue number and to separate it from the rest of the +text by a blank line. For example:: + + Help: Fix FooBar example robustness issue + + FooBar supports option X, but the example provided + would not work if Y was also specified. + + Fixes: #12345 + +GitLab will automatically create relevant links to the merge request and will +close the issue when the commit is merged into master. GitLab understands a few +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. + +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 +merging. + Topic Testing ============= ----------------------------------------------------------------------- Summary of changes: CONTRIBUTING.rst | 4 +++- Help/dev/review.rst | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 51 insertions(+), 1 deletion(-) hooks/post-receive -- CMake _______________________________________________ Cmake-commits mailing list Cmakeemail@example.com http://public.kitware.com/mailman/listinfo/cmake-commits