mirror of
https://github.com/slsdetectorgroup/slsDetectorPackage.git
synced 2026-01-22 14:01:05 +01:00
add guideline for Package Versioning to documentation also used as a test
This commit is contained in:
@@ -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})
|
||||
|
||||
9
docs/src/Versioning.rst
Normal file
9
docs/src/Versioning.rst
Normal 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.
|
||||
|
||||
@@ -66,6 +66,7 @@ slsDetectorPackage
|
||||
container_utils
|
||||
type_traits
|
||||
ToString
|
||||
Versioning
|
||||
|
||||
.. toctree::
|
||||
:caption: Firmware
|
||||
|
||||
Reference in New Issue
Block a user