detectors/slsDetectorPackage
24
1
Fork 0
mirror of https://github.com/slsdetectorgroup/slsDetectorPackage.git synced 2026-01-22 14:39:48 +01:00
Code Issues Actions Packages Releases Activity

add guideline for Package Versioning to documentation also used as a test

Browse Source
This commit is contained in:
mazzol_a
2026-01-13 16:43:32 +01:00
parent 6a7e29072e
commit 9a8307e6ab
3 changed files with 11 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

1
docs/CMakeLists.txt
View File

@@ -71,6 +71,7 @@ set(SPHINX_SOURCE_FILES
src/dataformat.rst src/dataformat.rst
src/softwarearchitecture.rst src/softwarearchitecture.rst
src/configcommands.rst src/configcommands.rst
src/Versioning.rst
) )
foreach(filename ${SPHINX_SOURCE_FILES}) foreach(filename ${SPHINX_SOURCE_FILES})

9
docs/src/Versioning.rst Normal file
View File

@@ -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.

1
docs/src/index.rst
View File

@@ -66,6 +66,7 @@ slsDetectorPackage
container_utils container_utils
type_traits type_traits
ToString ToString
Versioning
.. toctree:: .. toctree::
:caption: Firmware :caption: Firmware