Repository navigation
Commit f38b381
authored
docs: describe the fix field and the concrete suggestions (#32)
> **Held until the next commit-check release.** The `fix` field lives on
commit-check `main` (commit-check/commit-check#564) and is not in the
released 2.16.0 that this site pins. Merge this together with the
release's version bump.
## What
Follows commit-check/commit-check#564, which makes a failed check name
its correction when the fix is unambiguous and carries it in a new `fix`
field of the JSON output.
- **Command-line recipes → Reading the JSON**: explains `fix`, shows a
failed CC001 check with `suggest` and `fix` populated, and states when
`fix` stays empty (a subject with no type, a length limit, a
non-imperative verb).
- **Rules reference**: next to the generic sample output, a sample where
the suggestion names the correction (`Suggest: Use "fix: add x"`), taken
verbatim from the tool.
The MCP guide is unchanged: commit-check-mcp 0.1.9 does not pass `fix`
through yet. That guide gets its paragraph when the server does.
## Notes
- Sample outputs are the tool's real output and pass the docs-sync tests
(9 passed).
- No changelog entry: the changelog is written per release.
- Netlify deploy preview builds.1 parent ce718c7 commit f38b381
2 files changed
Lines changed: 38 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
276 | 276 | | |
277 | 277 | | |
278 | 278 | | |
| 279 | + | |
| 280 | + | |
| 281 | + | |
| 282 | + | |
| 283 | + | |
| 284 | + | |
| 285 | + | |
| 286 | + | |
| 287 | + | |
| 288 | + | |
| 289 | + | |
| 290 | + | |
| 291 | + | |
| 292 | + | |
| 293 | + | |
| 294 | + | |
| 295 | + | |
| 296 | + | |
| 297 | + | |
| 298 | + | |
| 299 | + | |
| 300 | + | |
| 301 | + | |
| 302 | + | |
| 303 | + | |
| 304 | + | |
| 305 | + | |
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
20 | 20 | | |
21 | 21 | | |
22 | 22 | | |
| 23 | + | |
| 24 | + | |
| 25 | + | |
| 26 | + | |
| 27 | + | |
| 28 | + | |
| 29 | + | |
| 30 | + | |
| 31 | + | |
| 32 | + | |
| 33 | + | |
23 | 34 | | |
24 | 35 | | |
25 | 36 | | |
| |||
0 commit comments