feature: add versioning documentation
This commit is contained in:
parent
f6539e059b
commit
ac62e47083
1 changed files with 21 additions and 0 deletions
21
versioning.md
Normal file
21
versioning.md
Normal file
|
|
@ -0,0 +1,21 @@
|
|||
# Versioning
|
||||
|
||||
We utilize a hybrid versioning scheme, blending [Semantic Versioning](https://semver.org/) with [CalVer](https://calver.org/):
|
||||
|
||||
```text
|
||||
YYYY-MM-DD-[RELEASE_TYPE]-N
|
||||
```
|
||||
|
||||
Components of the version number are as follows:
|
||||
- `YYYY`, `MM`, `DD`: Year, month, and day of release, respectively.
|
||||
- `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 on the same date.
|
||||
|
||||
Guidelines:
|
||||
- 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.
|
||||
Loading…
Add table
Add a link
Reference in a new issue