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 linter for markdown documents #3133

Merged
merged 9 commits into from
Feb 13, 2023
Merged

Conversation

crodriguezvega
Copy link
Contributor

Description

This PR is based on @faddat's idea to link the markdown documents. I have created a new PR from a different branch because it was easier for me to handle the conflicts and address @colin-axner's comment.

I will make sure to add @faddat as co-author when merging.

closes: #XXXX

Commit Message / Changelog Entry

N/A

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.

CHANGELOG.md Outdated Show resolved Hide resolved
docs/DOCS_README.md Show resolved Hide resolved
Copy link
Contributor

@tmsdkeys tmsdkeys left a comment

Choose a reason for hiding this comment

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

LGTM

MAINTAINERSHIP.md Outdated Show resolved Hide resolved
@crodriguezvega crodriguezvega merged commit e9d52c9 into main Feb 13, 2023
@crodriguezvega crodriguezvega deleted the carlos/markdown-lint branch February 13, 2023 14:54
stackman27 pushed a commit to stackman27/ibc-go that referenced this pull request Mar 13, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants