Skip to content

Commit a97d05c

Browse files
committed
Add documentation on Markdown linting to CONTRIBUTING.md
Signed-off-by: Douglas Stebila <dstebila@uwaterloo.ca> skip-checks: true
1 parent ecf42c5 commit a97d05c

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

CONTRIBUTING.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,12 @@ or running the CI locally (as above):
9090
act workflow_call -W '.github/workflows/basic.yml'
9191
```
9292

93+
Markdown documentation is checked with [markdownlint-cli2](https://github.com/DavidAnson/markdownlint-cli2) during the [basic.yml](.github/workflows/basic.yml) job, using the rules in [.markdownlint.yml](.markdownlint.yml). Changes to Markdown files can be validated locally with the same command CI runs:
94+
95+
```bash
96+
npx --yes markdownlint-cli2@0.22.1 --config .markdownlint.yml "**/*.md" "#build" "#**/build"
97+
```
98+
9399
### New features
94100

95101
Any PR introducing a new feature is expected to contain a test of this feature

0 commit comments

Comments
 (0)