diff --git a/docs/CMakeLists.txt b/docs/CMakeLists.txt index 62e11f673..129ed8e69 100644 --- a/docs/CMakeLists.txt +++ b/docs/CMakeLists.txt @@ -71,6 +71,7 @@ set(SPHINX_SOURCE_FILES src/dataformat.rst src/softwarearchitecture.rst src/configcommands.rst + src/Versioning.rst ) foreach(filename ${SPHINX_SOURCE_FILES}) diff --git a/docs/src/Versioning.rst b/docs/src/Versioning.rst new file mode 100644 index 000000000..1247577e3 --- /dev/null +++ b/docs/src/Versioning.rst @@ -0,0 +1,9 @@ +Package Versioning +=================== + +We use Semantic Versioning for our releases. Each version number is in the format MAJOR.MINOR.PATCH, where: + +- **MAJOR** version increments indicate incompatible API changes, +- **MINOR** version increments indicate added functionality in a backward-compatible manner, +- **PATCH** version increments indicate backward-compatible bug fixes. + diff --git a/docs/src/index.rst b/docs/src/index.rst index 4ba406a17..27d24045e 100644 --- a/docs/src/index.rst +++ b/docs/src/index.rst @@ -66,6 +66,7 @@ slsDetectorPackage container_utils type_traits ToString + Versioning .. toctree:: :caption: Firmware