From 7981317dd0c512bc17a79437f10a91c06a0db47d Mon Sep 17 00:00:00 2001 From: Daisuke Iuchi <42408108+da1suk8@users.noreply.github.com> Date: Mon, 6 Nov 2023 11:12:49 +0900 Subject: [PATCH] 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 --- CONTRIBUTING.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 073eefa80..178ba9313 100644 --- 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.