nonspec: add instructions for checking markdown formatting #1096
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
I got tired of getting errors after sending and updating PRs but didn't know how to run the style checker locally. Once I figured it out I suspected other folks might have a similar problem. Signed-off-by: Tom Hennen <[email protected]>
✅ Deploy Preview for slsa canceled.
|
joshuagl
reviewed
Jul 12, 2024
CONTRIBUTING.md
Outdated
| @@ -57,6 +57,25 @@ style, as encoded in our [markdownlint configuration](.markdownlint.yaml). In | |||
| addition we prefer to keep our Markdown documents wrapped at 80 columns (though | |||
| this is not currently enforced). | |||
|
|
|||
| To check (and fix) style problems before sending a PR you can install | |||
| and run [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2). | |||
There was a problem hiding this comment.
Oh, I haven't played with this (I typically just run the same command as the GHA workflow: npm run lint && ./lint.sh
Do you know if this CLI uses our .markdownlint.yaml and .markdownlintignore ?
There was a problem hiding this comment.
You know, I didn't:
- Know exactly how it worked already.
- Know that it supported fixing via
format. - Know how to get it working.
It looks like markdownlint-cli2 does support .markdownlint.yaml, but the .markdownlintignore is 'different' and the compatibility isn't quite right.
So I figured out how to use the same tooling as the workflow.
Signed-off-by: Tom Hennen <[email protected]>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Add instructions for checking markdown formatting using markdownlint-cli2.
I got tired of getting errors after sending and updating PRs but didn't know how to run the style checker locally. Once I figured it out I suspected other folks might have a similar problem.