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: style/formatting improvements for using ibc-go > overview #5808

Merged

Conversation

crodriguezvega
Copy link
Contributor

Description

This is the first of (probably) many PRs I will try to open to unify a bit the style of our docs following the recommendations of Google's developer documentation style guide. Jeez, I wish there was a linter for this...

closes: #XXXX

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 the 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.

@crodriguezvega crodriguezvega added the docs Improvements or additions to documentation label Feb 2, 2024
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.

Nice improvements @crodriguezvega! 🚀

docs/docs/01-ibc/01-overview.md Outdated Show resolved Hide resolved
docs/docs/01-ibc/01-overview.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.

seems like an sisyphian uphill battle 😅, maybe we should at least link the google style guide in the contributing guidelines someplace?

@crodriguezvega
Copy link
Contributor Author

seems like an sisyphian uphill battle 😅, maybe we should at least link the google style guide in the contributing guidelines someplace?

Sisyphos was a sissy compared to me, man. 😜
Yeap, we already do! :)

@crodriguezvega crodriguezvega merged commit c4d803e into main Feb 5, 2024
19 checks passed
@crodriguezvega crodriguezvega deleted the carlos/docs-style-improvements-using-ibc-go-overview branch February 5, 2024 11:39
@DimitrisJim
Copy link
Contributor

Sisyphos was a sissy compared to me, man. 😜

HAHA, absolutely destroyed.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants