Merge pull request #637 from shykes/contributing-faq

Contributing FAQ: how to run markdown linter manually
This commit is contained in:
Sam Alba 2021-06-15 10:59:33 +02:00 committed by GitHub
commit f0f24960c1
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23

View File

@ -84,3 +84,19 @@ Guidelines:
change the last commit (amend) instead of creating a new commit.
- Format: Use the imperative mood in the subject line: "If applied, this commit
will _your subject line here_"
## FAQ
### How to run the markdown linter locally
First install `markdownlint-cli`:
* On Mac OS: `brew install markdownlint-cli`
* On other systems, with yarn installed: `yarn global add markdownlint-cli`
Then from the repository root:
```
markdownlint -c .markdownlint.yaml docs/**/*.md
```