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

chore: use markdownlint to format markdown #2881

Closed
wants to merge 3 commits into from

Conversation

faddat
Copy link
Contributor

@faddat faddat commented Dec 5, 2022

Description

run

markdownlint . --fix

Commit Message / Changelog Entry

Apply markdownlint to the whole repository


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

@colin-axner
Copy link
Contributor

I like the idea of linting our docs. If we chose to use a markdown linter, we should have install instructions (or link to them) and add a make command

@faddat
Copy link
Contributor Author

faddat commented Dec 12, 2022

sure thing!

@faddat
Copy link
Contributor Author

faddat commented Jan 25, 2023

Hey @crodriguezvega sir thanks so much for your work on this PR, I hadn't seen it.

When I re-did this, I checked out main, and then force pushed to my branch. I think that everything should still be fine, though.

@crodriguezvega
Copy link
Contributor

Thanks a lot, @faddat, for this idea. It became a bit hard for me to fix the conflicts on this branch and address @colin-axner's comment, so I opened a new PR.

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