docs: add docs on semver and 0ver (#16835)

This commit is contained in:
Marko 2023-07-06 09:02:28 +02:00 committed by GitHub
parent c7270e8e22
commit fbe087dfbb
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 19 additions and 0 deletions

BIN
0ver.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

19
RELEASES.md Normal file
View File

@ -0,0 +1,19 @@
# Releases
The Cosmos-SDK follows both [0ver](https://0ver.org/) and [Semver](https://semver.org/). While this is confusing lets break it down: 0ver is used for the main Cosmos-SDK dependency (`github.com/cosmos/cosmos-sdk`) and Semver is used for all other dependencies.
## Semver Dependencies
Although we adhere to semantic versioning (semver), we have introduced a few modifications to accommodate the unique characteristics of blockchains. One significant divergence is that the major version (Y.x.x) is incremented solely when a consensus-breaking change occurs. On the other hand, the minor version (x.Y.x) is increased when there is a non-consensus-breaking alteration that also results in an incompatible API change. Patch versions will be bumped for all other changes that dont break the API nor Consensus.
<p align="center">
<img src="semver.png?raw=true" alt="Releases Semver decision tree" width="40%" />
</p>
## 0ver Dependencies
In terms of the Cosmos-SDK dependency, we adhere to a simpler versioning approach known as 0ver. This flow differs from the previous Semver flow. Under this system, when a consensus-breaking change or an API-breaking change occurs, the Cosmos-SDK team increments the minor version (x.Y.x). Conversely, when a non-consensus-breaking change and a non-API-breaking change take place, the team bumps the patch version (x.x.Y).
<p align="center">
<img src="0ver.png?raw=true" alt="Releases 0ver decision tree" width="40%" />
</p>

BIN
semver.png Normal file

Binary file not shown.

After

Width:  |  Height:  |  Size: 66 KiB