summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorCraig Scott <craig.scott@crascit.com>2017-08-05 10:55:49 (GMT)
committerCraig Scott <craig.scott@crascit.com>2017-08-08 11:17:32 (GMT)
commit11d00a17aafb33385a57a11b53862ac2197f116f (patch)
treeae47b775193642aceffef4cb522d71b3e4b49134 /CONTRIBUTING.rst
parent7c7a57ce9e14bf2eff1eb1de06e17a8216af1e18 (diff)
downloadCMake-11d00a17aafb33385a57a11b53862ac2197f116f.zip
CMake-11d00a17aafb33385a57a11b53862ac2197f116f.tar.gz
CMake-11d00a17aafb33385a57a11b53862ac2197f116f.tar.bz2
Help/dev: Add commit message guidelines
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst4
1 files changed, 3 insertions, 1 deletions
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