summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2017-06-15 18:30:28 (GMT)
committerBrad King <brad.king@kitware.com>2017-06-15 18:32:54 (GMT)
commitb0725f2fcd8c4a89e7e34a0b4eff4c6bc942e304 (patch)
tree813551604a0825bf447397cd078c2663559e9f60
parent7c5299add429d4b4714a6070bc6f8186585e9a2f (diff)
downloadCMake-b0725f2fcd8c4a89e7e34a0b4eff4c6bc942e304.zip
CMake-b0725f2fcd8c4a89e7e34a0b4eff4c6bc942e304.tar.gz
CMake-b0725f2fcd8c4a89e7e34a0b4eff4c6bc942e304.tar.bz2
Help/dev: Add review instructions to maintainer guide
-rw-r--r--Help/dev/maint.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/Help/dev/maint.rst b/Help/dev/maint.rst
index 78c06df..c448445 100644
--- a/Help/dev/maint.rst
+++ b/Help/dev/maint.rst
@@ -8,6 +8,36 @@ See documentation on `CMake Development`_ for more information.
.. contents:: Maintainer Processes:
+Review a Merge Request
+======================
+
+The `CMake Review Process`_ requires a maintainer to issue the ``Do: merge``
+command to integrate a merge request. Please check at least the following:
+
+* If the MR source branch is not named well for the change it makes
+ (e.g. it is just ``master`` or the patch changed during review),
+ add a ``Topic-rename: <topic>`` trailing line to the MR description
+ to provide a better topic name.
+
+* If the MR introduces a new feature or a user-facing behavior change,
+ such as a policy, ensure that a ``Help/release/dev/$topic.rst`` file
+ is added with a release note.
+
+* If a commit changes a specific area, such as a module, its commit
+ message should have an ``area:`` prefix on its first line.
+
+* If a commit fixes a tracked issue, its commit message should have
+ a trailing line such as ``Fixes: #00000``.
+
+* Ensure that the MR has been tested sufficiently. Typically it should
+ be staged for nightly testing with ``Do: stage``. Then manually
+ review the `CMake CDash Page`_ to verify that no regressions were
+ introduced. (Learn to tolerate spurious failures due to idiosyncrasies
+ of various nightly builders.)
+
+.. _`CMake Review Process`: review.rst
+.. _`CMake CDash Page`: https://open.cdash.org/index.php?project=CMake
+
Branch a New Release
====================