Update release docs with a section for versioning strategy

onflow · Oct 18, 2024 · bd46d4f · bd46d4f
1 parent 0b1fc2b
commit bd46d4f
Showing 1 changed file with 10 additions and 0 deletions.
diff --git a/docs/releasing.md b/docs/releasing.md
@@ -1,3 +1,13 @@
+# Versioning
+
+Versioning of Cadence releases follows the below strategy:
+- A language-breaking change (which is rare) would be a major version change.
+  - e.g: If the current version is `1.0.0` then the new version should be `v2.0.0`.
+- Any other changes that are not bug fixes, (feature additions, Go API changes, etc.) would be a minor version change.
+  - e.g: If the current version is `1.0.0` then the new version should be `v1.1.0`.
+- Bug fixes are patch versions.
+  - e.g: If the current version is `1.0.0` then the new version should be `v1.0.1`.
+
 # Release Process
 
 Assume releasing Cadence version `v0.21.2` from `master` branch.