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 description of IBC to docs/ibc/overview.md #10778

Merged
merged 2 commits into from
Dec 16, 2021

Conversation

barriebyron
Copy link
Contributor

Description

now that Vega upgrade has passed and IBC is a standalone module, a clear definition of the IBC project is needed more than ever. This helpful plain language description helps visitors understand IBC.

It's funny that I haven't submitted this fix before since I get frustrated every time I visit the IBC Overview doc and don't find the answer to the heading question What is the Inter-Blockchain Communication Protocol (IBC)?

Let's add a description of IBC following that question


Author Checklist

All items are required. Please add a note to the item if the item is not applicable and
please add links to any relevant follow up issues.

I have...

  • included the correct type prefix in the PR title
  • added ! to the type prefix if API or client breaking change
  • targeted the correct branch (see PR Targeting)
  • provided a link to the relevant issue or specification
  • followed the guidelines for building modules
  • included the necessary unit and integration tests
  • added a changelog entry to CHANGELOG.md
  • included comments for documenting Go code
  • updated the relevant documentation or specification
  • reviewed "Files changed" and left comments if necessary
  • confirmed all CI checks have passed

Reviewers Checklist

All items are required. Please add a note if the item is not applicable and please add
your handle next to the items reviewed if you only reviewed selected items.

I have...

  • confirmed the correct type prefix in the PR title
  • confirmed ! in the type prefix if API or client breaking change
  • confirmed all author checklist items have been addressed
  • reviewed state machine logic
  • reviewed API design and naming
  • reviewed documentation is accurate
  • reviewed tests and test coverage
  • manually tested (if applicable)

@barriebyron barriebyron self-assigned this Dec 14, 2021
@barriebyron barriebyron changed the title add description of IBC docs: add description of IBC to docs/ibc/overview.md Dec 14, 2021
Copy link
Contributor

@amaury1093 amaury1093 left a comment

Choose a reason for hiding this comment

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

Nice addition

@tac0turtle tac0turtle added the A:automerge Automatically merge PR once all prerequisites pass. label Dec 16, 2021
@mergify mergify bot merged commit ff590d1 into master Dec 16, 2021
@mergify mergify bot deleted the barriebyron-patch-1 branch December 16, 2021 10:49
@barriebyron
Copy link
Contributor Author

the "pre-provide-the-overview" page
image

not sure when the PR merge goes live, but I'll celebrate in advance. I'm glad to help reduce friction around understanding IBC

Happy holidays!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A:automerge Automatically merge PR once all prerequisites pass.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants