Skip to content

docs: one short line per change in the changelog - #79

Merged
shenxianpeng merged 3 commits into
mainfrom
docs/shorter-changelog
Nov 9, 2026
Merged

shenxianpeng merged 3 commits into
mainfrom
docs/shorter-changelog

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Nov 9, 2026 •

Copy link
Copy Markdown
Member

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)

Before After
before after

Example, v2.20.2:

  • Before: "--ai-only is 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-attribution policy option. --ai-only still 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."
  • After: "--ai-only is renamed --ai-attribution-only; the old name still works. (Guide, PR 677)"

What changes

Page Change
Changelog One sentence per change, v2.20.2 back to v2.0.0. Anchors (#v2202 etc.) 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.
Changelog, v2.6.0 Now lists --format json and 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).
Homepage FAQ "Python 3.10 through 3.15 … eighteen combinations" → "3.11 through 3.15 … fifteen combinations" (3.10 dropped in v2.20.0; CI matrix is 3.11–3.15).
Rules, CC013 The 120-word "What it does" sentence is now a short bulleted list. Same content.

Checks

  • mkdocs build --strict: clean.
  • python -m pytest tests -q with commit-check 2.20.2: 18 passed.

Summary by CodeRabbit

  • Documentation
    • Updated release highlights to one-line summaries, ordered newest first, with links to full release notes. Detailed entries are more concise.
    • Revised Python support guidance to cover versions 3.11–3.15 and 15 CI wheel-install combinations.
    • Clarified the documented AI attribution formats recognized by CC013, including Copilot coding-agent co-author lines.

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.
@netlify

netlify Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 2dcae80
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6af16256bd100d405eae9574
😎 Deploy Preview https://deploy-preview-79--commit-check.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@shenxianpeng shenxianpeng self-assigned this Nov 9, 2026
@coderabbitai

coderabbitai Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

Explain Change →

Caution

Review failed

The pull request is closed.

Walkthrough

The changelog now links to GitHub releases and condenses historical entries. The Python FAQ lists support for versions 3.11 through 3.15 and fifteen CI wheel-install combinations. The CC013 documentation groups recognized AI attribution forms and separately describes Copilot email-address recognition.

Changes: Release notes

Layer / File(s) Summary
Changelog highlights and release entries
docs/changelog.md
The introduction and version highlights are revised. Release entries from v2.20.2 through v2.0.0 are condensed.

Python support FAQ

Layer / File(s) Summary
Documented Python support range
docs/index.md
The FAQ changes the supported Python range from 3.10–3.15 to 3.11–3.15 and lists fifteen CI wheel-install combinations instead of eighteen.

CC013 attribution documentation

Layer / File(s) Summary
Recognized AI attribution forms
docs/rules.md
The CC013 description groups recognized attribution forms into bullets and separately describes Copilot email-address recognition.

Estimated code review effort: 2 (Simple) | ~10 minutes

Change: Other

Possibly related PRs

Merge Risk: Low · up to 2dcae

The documentation changes have bounded risk: readers using v2.20.1 may copy an unsupported option. Restore its historical name and distinguish the v2.20.2 rename; no runtime changes are involved.

- [ ] Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

@shenxianpeng
shenxianpeng merged commit 971fe23 into main Nov 9, 2026
7 checks passed
@shenxianpeng
shenxianpeng deleted the docs/shorter-changelog branch November 9, 2026 06:09
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant