summaryrefslogtreecommitdiffstats
path: root/CONTRIBUTING.rst
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-08-30 15:12:30 (GMT)
committerBrad King <brad.king@kitware.com>2019-08-30 15:12:30 (GMT)
commit2fa33613844420af3ebebb943a5fadf0c4c32d3a (patch)
tree15c6ea90626c764b69f827b1a950384402c58e82 /CONTRIBUTING.rst
parent2d01dcab29aaa60e905e828d4a07d2f72f7eeb20 (diff)
downloadCMake-2fa33613844420af3ebebb943a5fadf0c4c32d3a.zip
CMake-2fa33613844420af3ebebb943a5fadf0c4c32d3a.tar.gz
CMake-2fa33613844420af3ebebb943a5fadf0c4c32d3a.tar.bz2
CONTRIBUTING: Clarify creation of topic branch from target branch
The sentence "Base all new work on the upstream master branch." may be interpreted to mean that one should commit on a 'master' branch. Precede this with an explicit step for creating a topic branch.
Diffstat (limited to 'CONTRIBUTING.rst')
-rw-r--r--CONTRIBUTING.rst5
1 files changed, 3 insertions, 2 deletions
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
index 7e71111..7983be1 100644
--- a/CONTRIBUTING.rst
+++ b/CONTRIBUTING.rst
@@ -27,14 +27,15 @@ To contribute patches:
#. Run `Utilities/SetupForDevelopment.sh`_ for local git configuration.
#. See `Building CMake`_ for building CMake locally.
#. See the `CMake Source Code Guide`_ for coding guidelines.
-#. Base all new work on the upstream ``master`` branch.
+#. Create a topic branch named suitably for your work.
+ 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.
If in doubt, prefer ``master``. Reviewers may simply ask for
a rebase if deemed appropriate in particular cases.
#. Create commits making incremental, distinct, logically complete changes
with appropriate `commit messages`_.
-#. Push a topic branch to a personal repository fork on GitLab.
+#. Push the 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).
Check the box labelled "Allow commits from members who can merge to the