From a140ba9a338d84d9bbd2c14d82afe0b80fb25f4b Mon Sep 17 00:00:00 2001 From: Bart Feenstra Date: Mon, 25 Nov 2024 22:51:57 +0000 Subject: [PATCH] Document Betty's versioning --- documentation/about.rst | 1 + documentation/about/versions.rst | 12 ++++++++++++ 2 files changed, 13 insertions(+) create mode 100644 documentation/about/versions.rst diff --git a/documentation/about.rst b/documentation/about.rst index 0db9bcd8f..9bfd14ced 100644 --- 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 new file mode 100644 index 000000000..a9e358321 --- /dev/null +++ b/documentation/about/versions.rst @@ -0,0 +1,12 @@ +Versions +======== + +Betty releases follow `semantic versioning `_ (*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.