From 2fa33613844420af3ebebb943a5fadf0c4c32d3a Mon Sep 17 00:00:00 2001 From: Brad King Date: Fri, 30 Aug 2019 11:12:30 -0400 Subject: 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. --- CONTRIBUTING.rst | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) (limited to 'CONTRIBUTING.rst') diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 7e7111164e..7983be16ba 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 -- cgit v1.2.1