Skip to content

Commit

Permalink
add clarification on API breaking
Browse files Browse the repository at this point in the history
  • Loading branch information
mpoke committed Aug 15, 2023
1 parent 26ecf3f commit 951c7ea
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,8 +247,9 @@ ICS adheres to the [trunk based development branching model](https://trunkbasedd

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)):

- An API breaking change will result in an increase of the MAJOR version number (X.y.z | x > 0).
- A state breaking change (change requiring coordinated upgrade and/or state migration) will result in an increase of the MINOR version number (x.Y.z | x > 0).
- An library API breaking change will result in an increase of the MAJOR version number (X.y.z | x > 0).
- A state breaking change (change requiring coordinated upgrade and/or state migration for the consumer, the provider, or both) will result in an increase of the MINOR version number (x.Y.z | x > 0).
- Any other changes (including node API breaking changes) will result in an increase of the PATCH version number (x.y.Z | x > 0).

### Backwards Compatibility

Expand Down

0 comments on commit 951c7ea

Please sign in to comment.