Document Betty's versioning (#2223)

bartfeenstra · Nov 25, 2024 · 0348999 · 0348999
1 parent 0f86d0b
commit 0348999
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/documentation/about.rst b/documentation/about.rst
@@ -35,3 +35,4 @@ In this section
 ---------------
 - :doc:`/about/contributing`
 - :doc:`/about/license`
+- :doc:`/about/versions`
diff --git a/documentation/about/versions.rst b/documentation/about/versions.rst
@@ -0,0 +1,12 @@
+Versions
+========
+
+Betty releases follow `semantic versioning <https://semver.org/>`_ (*SemVer*). That means that each version number
+follows the ``major.minor.patch`` format, e.g. ``2.7.19``, where
+
+- ``major`` indicates the API version, and is incremented when releasing API changes
+- ``minor`` is incremented when new functionality is added that does not change existing APIs
+- ``patch`` is incremented when bugs are fixed that do not change existing APIs
+
+Any change to ``minor`` or ``patch`` is backwards-compatible with previous releases with the same ``major``, e.g. if you
+built a project or package based on Betty ``1.0.0``, any ``1.y.z`` release will be compatible.