Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add docs on semver and 0ver #16835

Merged
merged 2 commits into from
Jul 6, 2023
Merged
Show file tree
Hide file tree
Changes from 1 commit
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Next Next commit
add doc on semver and 0ver
  • Loading branch information
tac0turtle committed Jul 5, 2023
commit 68b43fc2984a46c0ea0ed4fd65cfe0cc420802a7
Binary file added 0ver.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
19 changes: 19 additions & 0 deletions RELEASES.md
Original file line number Diff line number Diff line change
@@ -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

While we follow semver we have made a few changes because of the way blockchains way. The main difference is that the major version (Y.x.x) is only bumped in the case of a consensus breaking change. The minor version (x.Y.x) is bumped in the case of a non-consensus breaking change but a incompatible API breaking change.

<p align="center">
<img src="semver.png?raw=true" alt="Releases Semver decision tree" width="40%" />
</p>

## 0ver Dependencies

With the Cosmos-SDK depency we follow 0ver. This is a simpler flow than the previous Semver flow. When there is a consensus breaking change or api breaking change, the Cosmos-sdk team will bump the minor version (x.Y.x). When there is a non-consensus breaking change and a non-api breaking change, the Cosmos-sdk team will bump the patch version (x.x.Y).

<p align="center">
<img src="0ver.png?raw=true" alt="Releases 0ver decision tree" width="40%" />
</p>
Binary file added semver.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.