summaryrefslogtreecommitdiff
path: root/lib/mlibc/RELEASE_PROCEDURE.md
diff options
context:
space:
mode:
authorIan Moffett <ian@osmora.org>2024-03-07 17:28:00 -0500
committerIan Moffett <ian@osmora.org>2024-03-07 17:28:32 -0500
commitbd5969fc876a10b18613302db7087ef3c40f18e1 (patch)
tree7c2b8619afe902abf99570df2873fbdf40a4d1a1 /lib/mlibc/RELEASE_PROCEDURE.md
parenta95b38b1b92b172e6cc4e8e56a88a30cc65907b0 (diff)
lib: Add mlibc
Signed-off-by: Ian Moffett <ian@osmora.org>
Diffstat (limited to 'lib/mlibc/RELEASE_PROCEDURE.md')
-rw-r--r--lib/mlibc/RELEASE_PROCEDURE.md18
1 files changed, 18 insertions, 0 deletions
diff --git a/lib/mlibc/RELEASE_PROCEDURE.md b/lib/mlibc/RELEASE_PROCEDURE.md
new file mode 100644
index 0000000..6030205
--- /dev/null
+++ b/lib/mlibc/RELEASE_PROCEDURE.md
@@ -0,0 +1,18 @@
+# Versioning
+
+mlibc uses semantic versioning to denote releases.
+A bump in the major version signals an ABI break.
+A bump in the minor version signals a newly released set of features, while still maintaining ABI.
+A bump in the patch signals a bug-fix, while not adding new features.
+
+# Release schedule
+
+A minor or major version will be released every two months (every even month). A release is turned into a major one
+when there is a pending ABI break, given that the ABI hasn't been broken in the last 6 months.
+A patch version will be released on-demand, as bugs are fixed.
+
+When a new minor or major version is to be released, first a release candiate ("rc") will
+be released. This release candiate will become the definite release after a week. During
+this time, end-users shall test the rc and determine if there are breaking changes. Several
+rc's can be released (``rc-1``, ``rc-2``, etc.). Once the rc is confirmed to be in a stable
+state, the final version is to be released.