Merge pull request #271 from clEsperanto/add-versioning-doc

add versioning page
clEsperanto · Mar 29, 2024 · 917f842 · 917f842
2 parents 8cb6539 + 6db474a
commit 917f842
Show file tree

Hide file tree

Showing 2 changed files with 14 additions and 0 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -23,6 +23,7 @@ For usage documentation, please refer to one of the following links:
    tests
    usage
    contribute
+   versioning
 
 .. toctree::
    :caption: API Documentation

diff --git a/docs/source/versioning.rst b/docs/source/versioning.rst
@@ -0,0 +1,13 @@
+Versioning
+----------
+
+The versioning of this project is based on the `Semantic Versioning Specification <http://semver.org/>__`.
+
+Semantic Versions are in the format: ``MAJOR.MINOR.PATCH``.
+
+   - :If you have fixed a bug: increase the patch version
+   - :If you have introduced new functionality in a non-breaking way: increase the minor version (and reset patch to 0)
+   - :If you have introduced breaking changes: increase the major version (and reset the patch and minor version to 0).
+
+The project version is managed in the `CMakelists.txt <https://github.com/clEsperanto/CLIc/blob/master/CMakeLists.txt>__` file at the root of the repository.
+