Repository navigation
docs: one short line per change in the changelog - #79
Conversation
Each entry now says what changed in one sentence, with links to the rule, the guide and the PR. Internal-only items (refactors, test and CI fixes) are left to the GitHub releases. Also lists the JSON output and Python API under v2.6.0, where they shipped. The homepage FAQ said Python 3.10 through 3.15; it is 3.11 through 3.15 since v2.20.0. The CC013 rule text is now a list instead of one long sentence.
✅ Deploy Preview for commit-check ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
Caution Review failedThe pull request is closed. Walkthrough
Merge Risk:
|
Makes the changelog readable at a glance: every change is one short sentence, followed by links to the rule, the guide and the PR. The page goes from about 6,400 words to about 2,300 (most of what is left is links).
Before vs after (v2.20.x)
Example, v2.20.2:
--ai-onlyis now--ai-attribution-only— the new name says what the run is limited to: the AI attribution of the text, and it pairs with the--ai-attributionpolicy option.--ai-onlystill works, so a script written against 2.20.1 needs no change; it is no longer listed in--help. See Checking a pull request description. See PR 677."--ai-onlyis renamed--ai-attribution-only; the old name still works. (Guide, PR 677)"What changes
#v2202etc.) unchanged, so blog links still work. Section names unified to Breaking / Added / Changed / Fixed. Internal-only items (refactors, a test mock fix, SonarQube, OpenSSF badge) dropped; the GitHub releases still list them. Highlights rows for 2.20.1, 2.20.0, 2.19.2 shortened.--format jsonand the Python API (commit-check/commit-check#396), which shipped in 2.6.0 but were missing from the entry. Added CLI PR links where entries had none (commit-check/commit-check#412, commit-check/commit-check#544, commit-check/commit-check#559, commit-check/commit-check#560).Checks
mkdocs build --strict: clean.python -m pytest tests -qwith commit-check 2.20.2: 18 passed.Summary by CodeRabbit