diff --git a/versioning.md b/versioning.md new file mode 100644 index 0000000..d86c69d --- /dev/null +++ b/versioning.md @@ -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.