Skip to content

Commit bd91e5c

Browse files
tarun-etikalaclaude
andcommitted
docs: restore markdownlint section in CONTRIBUTING.md
Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 1fed94d commit bd91e5c

1 file changed

Lines changed: 12 additions & 1 deletion

File tree

CONTRIBUTING.md

Lines changed: 12 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -47,7 +47,18 @@ ruff format --check . # format check
4747
ruff format . # auto-format
4848
```
4949

50-
Configuration is in [`ruff.toml`](ruff.toml) at the repo root. For markdownlint config, see [`.markdownlint.jsonc`](.markdownlint.jsonc) (rules) and [`.markdownlint-cli2.yaml`](.markdownlint-cli2.yaml) (ignored paths).
50+
Configuration is in [`ruff.toml`](ruff.toml) at the repo root.
51+
52+
### Markdown (markdownlint)
53+
54+
Run locally before pushing:
55+
56+
```bash
57+
npx markdownlint-cli2@0.22.1 "**/*.md" # lint
58+
npx markdownlint-cli2@0.22.1 --fix "**/*.md" # auto-fix
59+
```
60+
61+
Configuration is in [`.markdownlint.jsonc`](.markdownlint.jsonc) (rules) and [`.markdownlint-cli2.yaml`](.markdownlint-cli2.yaml) (ignored paths) at the repo root.
5162

5263
## Commit message conventions
5364

0 commit comments

Comments
 (0)