kjuulh/dagger
Archived
1
0
Fork 0
Code Issues 1 Pull Requests 1 Projects Releases Wiki Activity

Contributing FAQ: how to run markdown linter manually

Browse Source 
Signed-off-by: Solomon Hykes <solomon@dagger.io>
This commit is contained in:
Solomon Hykes 2021-06-14 16:11:37 +00:00
parent ffd4187660
commit 906b9bc992
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
CONTRIBUTING.md
View File

@ -84,3 +84,19 @@ Guidelines:
change the last commit (amend) instead of creating a new commit. change the last commit (amend) instead of creating a new commit.
- Format: Use the imperative mood in the subject line: "If applied, this commit - Format: Use the imperative mood in the subject line: "If applied, this commit
will _your subject line here_" 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
```