From b7e845841efbc92dfeafee89ed3283616f91a0eb Mon Sep 17 00:00:00 2001 From: Trask Stalnaker Date: Wed, 26 Nov 2025 11:06:42 -0800 Subject: [PATCH] Add CONTRIBUTING.md note for Windows users --- CONTRIBUTING.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 3c90039e4..d03896505 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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: