Skip to content

Commit

Permalink
update semantic versioning
Browse files Browse the repository at this point in the history
  • Loading branch information
mpoke committed Aug 14, 2023
1 parent f636cfc commit e94effe
Showing 1 changed file with 3 additions and 10 deletions.
13 changes: 3 additions & 10 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -245,17 +245,10 @@ ICS adheres to the [trunk based development branching model](https://trunkbasedd

### Semantic Versioning

ICS uses a variation of [semantic versioning](https://semver.org/).
ICS follows [semantic versioning](https://semver.org), but with the following deviations (similar to [IBC-Go](https://github.com/cosmos/ibc-go/blob/main/RELEASES.md)):

Note that state breaking changes are a subset of consensus breaking changes. Therefore we'll only refer to the latter when talking about versioning.

ICS is a distributed, IBC based protocol in which multiple blockchains could be affected by a version bump. Therefore incrementing a MAJOR version number indicates that the PR updates, or is a breaking change to the way that the provider and consumer(s) communicate with one another over IBC. If a PR is consensus breaking to both the provider and consumer(s), then it requires a MAJOR version bump.

Incrementing a MINOR version number indicates that a PR is only consensus breaking to the provider, or only to the consumers, where IBC communication remains unchanged.

Incrementing a PATCH version number indicates that a PR is not consensus breaking to the provider or consumers. This could include node API changes, or other miscellaneous and often rare changes.

Pure documentation, testing, and refactoring PRs do not require a version bump.
- An API breaking change will result in an increase of the MAJOR version number (X.y.z | x > 0).
- A state breaking change will result in an increase of the MINOR version number (x.Y.z | x > 0).

### Backwards Compatibility

Expand Down

0 comments on commit e94effe

Please sign in to comment.