Merge pull request #94 from TUDelft-CITG/add-version-info-to-document…

…ation

Add version info to documentation

README.md

@@ -1,8 +1,9 @@
-[ ![Documentation](https://img.shields.io/badge/sphinx-documentation-informational.svg)](https://openclsim.readthedocs.io)
-[ ![License: MIT](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/TUDelft-CITG/OpenCLSim/blob/master/LICENSE.txt)
+[![Documentation](https://img.shields.io/badge/sphinx-documentation-informational.svg)](https://openclsim.readthedocs.io)
+[![License: MIT](https://img.shields.io/badge/License-MIT-informational.svg)](https://github.com/TUDelft-CITG/OpenCLSim/blob/master/LICENSE.txt)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3730616.svg)](https://doi.org/10.5281/zenodo.3730616)
 
 [![CircleCI](https://circleci.com/gh/TUDelft-CITG/OpenCLSim.svg?style=svg&circle-token=fc95d870dc21fdf11e1ebc02f9defcd99212197a)](https://circleci.com/gh/TUDelft-CITG/OpenCLSim)
+[![Coverage](https://artifact-getter.herokuapp.com/get_coverage_badge?circle_url=https://circleci.com/gh/TUDelft-CITG/OpenCLSim&circle_token=3b00333d4fe20c813bd9bc81ce2e1d4f5fae987aoutput=str)](https://artifact-getter.herokuapp.com/get_coverage_report?circle_url=https://circleci.com/gh/TUDelft-CITG/OpenCLSim&circle_token=3b00333d4fe20c813bd9bc81ce2e1d4f5fae987a)
 
 # OpenCLSim
 

docs/index.rst

@@ -18,6 +18,7 @@ Welcome to OpenCLSim documentation! Please check the contents below for informat
    contributing
    authors
    history
+   version-conventions
 
 Indices and tables
 ==================

docs/version-conventions.rst

@@ -0,0 +1,16 @@
+===================
+Version conventions
+===================
+
+This package is being developed continuously. Branch protection is turned on for the master branch. Useful new features and bugfixes can be developed in a separate branch or fork. Pull requests can be made to integrate updates into the master branch. To keep track of versions, every change to the master branch will receive a version tag. This page outlines the version tags' naming convention.
+
+Each change to the master branch is stamped with a unique version identifier. We use sequence based version identifiers, that consist of a sequence of three numbers: the first number is a major change identifier, followed by a minor change idenfier and finally a maintenance identifier. This leads to version identifiers of the form:
+
+major.minor.maintenance (example: 1.2.2)
+
+The following guideline gives an idea what types of changes are considered major changes, minor changes and maintenance:
+
+- Major changes (typically breaking changes)  -> major + 1
+- Minor changes (typically adding of new features) -> minor + 1
+- Maintenance (typically bug fixes and updates in documentation -> maintenance + 1
+