-
Notifications
You must be signed in to change notification settings - Fork 3.7k
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: add markdownlint to lint commands #9353
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for doing this. I love this extension and I've been using it for a long time.
Had a chat with @ryanchristo . The default Markdown lint yields lot of errors, and many of them are are not auto fixable. |
For clarification, we are using the same configuration as tendermint, not the default configuration.
It would be nice if we did not alter the configuration because it is currently the same configuration for tendermint but this would be one way to break up the work. I don't mind going through and fixing all the lint warnings if this needs to be done but it will be a lot of changes for one pull request so I just wanted to double check with others before moving forward. |
I'm fine with a 3k line diff in this PR, but maybe the commits could be well separated into 1/ auto-fix and 2/ manual fixes, to make the review easier (the reviewer can run auto-fix locally, and just review the manual fixes, and make sure the output diff is the same as this PR's) (also want to be respectful of Ryan doing a lot of repetitive chore work, if there's too much work for one PR, we can consider muting some lints for now and doing multiple PRs). |
If you want to manually fix few thousands lines of code then fair enough 💪 Just wanted to point that it's not very important. |
e1ac8d6
to
9765c5e
Compare
I'm definitely reevaluating after further reviewing the warnings and changes. I'm also unsure about a couple configuration options such as the addition of angle brackets around links. I'm going to explore your initial suggestions @robert-zaremba. Thanks! |
71f89b9
to
10dd068
Compare
1f4c23f
to
7d62a51
Compare
c45064d
to
a35e222
Compare
@marbar3778 I'm receiving the following error with the Atlas checks:
Any ideas? |
a35e222
to
a088683
Compare
a088683
to
40d6b65
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lgtm
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Good job.
If there is any follow up task (eg to change some rules), then let's create an issue for it.
i was goingi to put automerge, but saw atlas failing. Do we want to fix that before merging? cc @alexanderbez @marbar3778 |
I messaged @marbar3778 in Discord and he said he was looking into this but it does not need to be solved before merging. It should be safe to add automerge. |
yea feel free to merge. I need to dive into it. |
* add markdownlint config * update make lint commands * update markdownlint config * run make lint-fix * fix empty link * resuse docker container * run lint-fix * do not echo commands Co-authored-by: ryanchrypto <[email protected]>
Description
This pull request adds markdownlint to the lint commands defined in
Makefile
.make lint
will now report issues with markdown filesmake lint-fix
will now attempt to fix issues with markdown filesThe configuration for markdownlint was originally copied from tendermint (see markdownlint.yml) and then modified to include additional rules to help limit the scope of this pull request.
.markdownlint.json
and.markdownlintignore
set the configurationdocs/basics/app-anatomy.md
was updated manually for a missing linkmake lint-fix
commandcloses: #8112
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.
docs/
) or specification (x/<module>/spec/
) - n/agodoc
comments. - n/aUnreleased
section inCHANGELOG.md
- n/aFiles changed
in the Github PR explorerCodecov Report
in the comment section below once CI passes - n/a