Skip to content

Commit

Permalink
update CONTRIBUTING.md (#239)
Browse files Browse the repository at this point in the history
  • Loading branch information
plafer authored Nov 14, 2022
1 parent 765a01c commit 6a6999b
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 2 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@

This release includes major improvements in making the library compatible with ibc-go v5.0.1. This includes making ibc events compatible and removing the crossing-hellos logic from the connection and channel handshakes.

There are consensus-breaking changes in the connection and channel handshakes. However, there are no consensus-breaking changes for already established channels.

### BREAKING CHANGES

- Make connection events compatible with ibc-go
Expand Down
6 changes: 4 additions & 2 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -225,6 +225,7 @@ Our release process is as follows:
2. Running `unclog release --editor <editor> --version vX.Y.Z` to create a summary of all of the changes
in this release.
1. Your text editor will open. Write the release summary, and close the editor.
1. Make sure to include a comment on whether or not the release contains consensus-breaking changes.
2. Add this same summary to `CHANGELOG.md` as well.
3. Committing the updated `CHANGELOG.md` file and `.changelog` directory to the repo.
2. Push this to a branch `release/vX.Y.Z` according to the version number of
Expand All @@ -247,8 +248,9 @@ Our release process is as follows:
9. Once all crates have been successfully released, create a signed tag and push it to
GitHub: `git tag -s -a vX.Y.Z`. In the tag message, write the version and the link
to the corresponding section of the changelog.
10. Once the tag is pushed, wait for the CI bot to create a GitHub release, and update
the release description to `[📖 CHANGELOG](https://github.com/cosmos/ibc-rs/blob/main/CHANGELOG.md#vXYZ)`.
10. Once the tag is pushed, create a GitHub release and append
`[📖CHANGELOG](https://github.com/cosmos/ibc-rs/blob/main/CHANGELOG.md#vXYZ)`
to the release description.
11. All done! 🎉

[crates.io]: https://crates.io
Expand Down

0 comments on commit 6a6999b

Please sign in to comment.