Commit 2fa33613 authored by Brad King's avatar Brad King

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.
parent 2d01dcab
...@@ -27,14 +27,15 @@ To contribute patches: ...@@ -27,14 +27,15 @@ To contribute patches:
#. Run `Utilities/SetupForDevelopment.sh`_ for local git configuration. #. Run `Utilities/SetupForDevelopment.sh`_ for local git configuration.
#. See `Building CMake`_ for building CMake locally. #. See `Building CMake`_ for building CMake locally.
#. See the `CMake Source Code Guide`_ for coding guidelines. #. 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 Base work on the upstream ``release`` branch only if it fixes a
regression or bug in a feature new to that release. regression or bug in a feature new to that release.
If in doubt, prefer ``master``. Reviewers may simply ask for If in doubt, prefer ``master``. Reviewers may simply ask for
a rebase if deemed appropriate in particular cases. a rebase if deemed appropriate in particular cases.
#. Create commits making incremental, distinct, logically complete changes #. Create commits making incremental, distinct, logically complete changes
with appropriate `commit messages`_. 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 #. Create a GitLab Merge Request targeting the upstream ``master`` branch
(even if the change is intended for merge to the ``release`` 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 Check the box labelled "Allow commits from members who can merge to the
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment