From bd46d4feb27cb8f9f8428a1d876211fbf6ffc183 Mon Sep 17 00:00:00 2001 From: Supun Setunga Date: Fri, 18 Oct 2024 12:31:35 -0700 Subject: [PATCH] Update release docs with a section for versioning strategy --- docs/releasing.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/releasing.md b/docs/releasing.md index 38321f7155..b6cdb8e15d 100644 --- 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.