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: reasoning and use cases for channel upgradability #5346

Conversation

charleenfei
Copy link
Contributor

Description

closes: #5267

Commit Message / Changelog Entry

type: commit message

see the guidelines for commit messages. (view raw markdown for examples)


Before we can merge this PR, please make sure that all the following items have been
checked off. If any of the checklist items are not applicable, please leave them but
write a little note why.

  • Targeted PR against correct branch (see CONTRIBUTING.md).
  • Linked to Github issue with discussion and accepted design OR link to spec that describes this work.
  • Code follows the module structure standards and Go style guide.
  • Wrote unit and integration tests.
  • Updated relevant documentation (docs/) or specification (x/<module>/spec/).
  • Added relevant godoc comments.
  • Provide a commit message to be used for the changelog entry in the PR description for review.
  • Re-reviewed Files changed in the Github PR explorer.
  • Review Codecov Report in the comment section below once CI passes.

@charleenfei charleenfei changed the title docs: document reasoning and use cases for channel upgradability docs: reasoning and use cases for channel upgradability Dec 8, 2023
Copy link
Contributor

@crodriguezvega crodriguezvega left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for picking up a bunch of the documentation issues, @charleenfei.

docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
@crodriguezvega crodriguezvega added channel-upgradability Channel upgradability feature docs Improvements or additions to documentation labels Dec 13, 2023
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
Copy link
Member

@damiannolan damiannolan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Awesome! LGTM 🚀

Left a couple of nits and suggestions on wording, feel free to apply which ones you want :)

docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/06-channel-upgrades.md Outdated Show resolved Hide resolved
Copy link
Contributor

@DimitrisJim DimitrisJim left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

don't have much to add reading previous reviews, looks great to me! 🎊

@charleenfei charleenfei enabled auto-merge (squash) December 18, 2023 16:29
…channel-upgradability' of github.com:cosmos/ibc-go into charly/issue#5267-document-reasoning-and-use-cases-for-channel-upgradability
@charleenfei charleenfei merged commit 4d2ce43 into 04-channel-upgrades Dec 18, 2023
17 of 18 checks passed
@charleenfei charleenfei deleted the charly/issue#5267-document-reasoning-and-use-cases-for-channel-upgradability branch December 18, 2023 16:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
channel-upgradability Channel upgradability feature docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants