2024-05-12 13:27:01 +02:00
|
|
|
# Versioning
|
|
|
|
|
|
|
|
|
|
We utilize a hybrid versioning scheme, blending [Semantic Versioning](https://semver.org/) with [CalVer](https://calver.org/):
|
|
|
|
|
|
|
|
|
|
```text
|
2024-05-16 11:12:50 +02:00
|
|
|
YYYY-MM-[RELEASE_TYPE]-N
|
2024-05-12 13:27:01 +02:00
|
|
|
```
|
|
|
|
|
|
|
|
|
|
Components of the version number are as follows:
|
2024-05-21 14:40:05 +02:00
|
|
|
|
|
|
|
|
- `YYYY`, `MM`: Year and month of release.
|
|
|
|
|
- `RELEASE_TYPE`: Specifies the development stage:
|
|
|
|
|
- `alpha`: Initial testing phase.
|
|
|
|
|
- `beta`: Near-complete features, further testing.
|
|
|
|
|
- `rc` (release candidate): Stability testing, bug fixes.
|
|
|
|
|
- `final`: Production-ready release.
|
|
|
|
|
- `N`: Incremental release number for multiple releases within one month.
|
2024-05-12 13:27:01 +02:00
|
|
|
|
|
|
|
|
Guidelines:
|
2024-05-21 14:40:05 +02:00
|
|
|
|
|
|
|
|
- Automated scripts should generate version numbers to avoid errors.
|
|
|
|
|
- Ensure tool compatibility with the hybrid version format.
|
|
|
|
|
- Maintain detailed changelogs for transparency on progression from alpha to final.
|
