Skip to content
Snippets Groups Projects
Commit b9e9d64c authored by Paul McCarthy's avatar Paul McCarthy :mountain_bicyclist:
Browse files

Updated contributing guide r.e. version number

parent 7bb76473
No related branches found
No related tags found
No related merge requests found
...@@ -29,25 +29,26 @@ Releases ...@@ -29,25 +29,26 @@ Releases
A separate branch is created for each release. The name of the branch is A separate branch is created for each release. The name of the branch is
``v[release]``, where ``[release]`` is the version number (see below). For ``v[release]``, where ``[release]`` is the ``major.minor`` version number (see
example, the branch name for release ``1.0.0`` would be ``v1.0.0``. Hotfixes below). For example, the branch name for release ``1.0`` would be ``v1.0``.
may be added to these release branches. Hotfixes should be merged into the Hotfixes may be added to these release branches. Hotfixes should be merged
master branch, and then cherry-picked onto the release branch(es). into the master branch, and then cherry-picked onto the release branch(es).
Every release (including hotfixes) is also tagged with its version number. Every release (including hotfixes) is also tagged with its version number.
For example, the first commit in the ``v1.0.0`` branch would also be tagged For example, the first commit in the ``v1.0`` branch would also be tagged with
with ``1.0.0``. ``1.0``. A maintenance release to the ``v1.0`` branch would be tagged with
``1.0.1``.
Version number Version number
-------------- --------------
The ``fslpy`` version number follows `semantic versioning The ``fslpy`` version number roughly follows `semantic versioning
<http://semver.org/>`_ rules, so that dependant projects are able to perform <http://semver.org/>`_ rules, so that dependant projects are able to perform
compatibility testing. The full version number string consists of three compatibility testing. The full version number string consists of three
numbers:: numbers:
major.minor.patch major.minor.patch
...@@ -60,9 +61,6 @@ numbers:: ...@@ -60,9 +61,6 @@ numbers::
- The ``major`` number is incremented on major feature additions, and - The ``major`` number is incremented on major feature additions, and
backwards-incompatible changes. backwards-incompatible changes.
Additionally, a single letter (``a``, ``b``, ``c``, etc) may be appended
to the version number, indicating a hotfix release.
Testing Testing
------- -------
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment