docs: add the description of versioning rule (#330)

* docs: add Releases To explain our versiong rule * fix: reflect comment - reversed Y.Y.Y and ZZZ - added additional information * fix: reflect comment - reversed Z.Z.Z and YYY - fix explanation * fix: reflect comment * fix: fix format
Finschia · Nov 6, 2023 · 7981317 · 7981317
1 parent 344858d
commit 7981317
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -39,3 +39,8 @@ TBD
 4. You may merge the pull request in once you have the sign-off of two other developers, or if you
    do not have permission to do that, you may request the second reviewer to merge it for you.
 
+## Releases
+
+Release is maintained in a release branch named `vX.X.X+Z.Z.Z` where `vX.X.X` is the original CosmWasm's release version, `Z.Z.Z` is our release version and if additional information (e.g. rc, alpha) is needed, add `YYY` (e.g. `vX.X.X-YYY+Z.Z.Z`).
+
+The reason we use build metadata (`+`) instead of pre-release versioning (`-`) is because CosmWasm's release version overrides the pre-release version.