Skip to content

Add CONTRIBUTING.md section for running markdown lint #2482

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
trask merged 1 commit into from
Nov 27, 2025
Merged

Add CONTRIBUTING.md section for running markdown lint #2482

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,24 @@ To run the tests:
./gradlew test
```

## Markdown linting

This repository uses [markdownlint](https://github.com/DavidAnson/markdownlint) via `markdownlint-cli2` managed by [mise](https://github.com/jdx/mise).

To check all Markdown files:

```bash
mise run lint:markdown
```

(note: Windows users may need to run `mise install` first)

To automatically fix fixable issues:

```bash
mise run lint:markdown --fix
```

## Snapshot Builds

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