Skip to content

Commit edfe63f

Browse files
authored
Add CONTRIBUTING.md section for running markdown lint (#2482)
1 parent 2b22c3b commit edfe63f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

CONTRIBUTING.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,24 @@ To run the tests:
3131
./gradlew test
3232
```
3333

34+
## Markdown linting
35+
36+
This repository uses [markdownlint](https://github.com/DavidAnson/markdownlint) via `markdownlint-cli2` managed by [mise](https://github.com/jdx/mise).
37+
38+
To check all Markdown files:
39+
40+
```bash
41+
mise run lint:markdown
42+
```
43+
44+
(note: Windows users may need to run `mise install` first)
45+
46+
To automatically fix fixable issues:
47+
48+
```bash
49+
mise run lint:markdown --fix
50+
```
51+
3452
## Snapshot Builds
3553

3654
Snapshot builds of the `main` branch are available from the Sonatype snapshot repository at:

0 commit comments

Comments
 (0)