From 145394e27e718cf210c1e196d524df1e0ada66f5 Mon Sep 17 00:00:00 2001 From: Paul McCarthy <pauldmccarthy@gmail.com> Date: Sat, 3 Jun 2017 16:28:59 +0100 Subject: [PATCH] Tweaks to contributing guide --- doc/contributing.rst | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) diff --git a/doc/contributing.rst b/doc/contributing.rst index ca5751c93..e2b119486 100644 --- a/doc/contributing.rst +++ b/doc/contributing.rst @@ -51,19 +51,20 @@ Releases A separate branch is created for each **minor** release. The name of the branch is ``v[major.minor]``, where ``[major.minor]`` is the first two -components of the release version number (see below). For example, the branch +components of the release version number (see above). For example, the branch name for minor release ``1.0`` would be ``v1.0``. -Patches and hotfixes may be added to these release branches. These should be -merged into the master branch, and then cherry-picked onto the release -branch(es). +Patches and bugfixes may be added to these release branches as ``point`` +releases. These changes should be made on the master branch like any other +change (i.e. via merge requests), and then cherry-picked onto the relevant +release branch(es). -Every release is also tagged with its full version number. For example, the -first release off the ``v1.0`` branch would be tagged with ``1.0.0``. -Maintenance release to the ``v1.0`` branch would be tagged with ``1.0.1``, -``1.0.2``, etc. +Every release commit is also tagged with its full version number. For +example, the first release off the ``v1.0`` branch would be tagged with +``1.0.0``. Point releases to the ``v1.0`` branch would be tagged with +``1.0.1``, ``1.0.2``, etc. Testing -- GitLab