Skip to content

docs: improve Why Commit Check comparison table#413

Merged
shenxianpeng merged 2 commits into
mainfrom
chore/improve-comparison-table
May 15, 2026
Merged

docs: improve Why Commit Check comparison table#413
shenxianpeng merged 2 commits into
mainfrom
chore/improve-comparison-table

Conversation

@shenxianpeng
Copy link
Copy Markdown
Member

@shenxianpeng shenxianpeng commented May 15, 2026 •
edited by coderabbitai Bot
Loading

Summary

Improves the "Why Commit Check?" comparison table in README.rst:

Changes

  1. Fix commitlint signed-off-by: Changed from ✅ to Partial because signed-off-by requires the community @commitlint/rule-signed-off-by plugin — not part of @commitlint/config-conventional. Added footnote [#f1].

  2. Add YACC (Yet Another Commit Checker) column: YACC is already mentioned in the Overview as a tool commit-check is an alternative to. Adding it to the comparison table provides a complete competitive landscape. Footnote [#f2] explains its context.

  3. Add 3 new comparison rows:

    • Open source & free
    • Client-side (pre-commit) enforcement
    • AI-native (JSON API + Python SDK)

Verification

All Commit Check ✅ entries verified against source code (rules_catalog.py, engine.py, rule_builder.py, api.py).

Summary by CodeRabbit

  • Documentation
    • Expanded the feature comparison table with detailed information and improved layout structure for clearer feature comparison across options.

Review Change Stack

@shenxianpeng shenxianpeng requested a review from a team as a code owner May 15, 2026 23:41
@netlify
Copy link
Copy Markdown

netlify Bot commented May 15, 2026 •
edited
Loading

✅ Deploy Preview for commit-check ready!

Name Link
🔨 Latest commit 60f84e0
🔍 Latest deploy log https://app.netlify.com/projects/commit-check/deploys/6a07b1eb1335d90008b2d056
😎 Deploy Preview https://deploy-preview-413--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.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 15, 2026 •
edited
Loading

Caution

Review failed

The pull request is closed.

ℹ️ Recent review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 9dc09082-4d95-496d-b4d9-f61ef19ed43a

📥 Commits

Reviewing files that changed from the base of the PR and between 657d391 and 60f84e0.

📒 Files selected for processing (1)
  • README.rst
📝 Walkthrough

Walkthrough

The README.rst file is updated with an expanded "Why Commit Check?" comparison table that replaces the prior simplified structure with a more detailed four-column feature matrix. The table now covers seventeen feature dimensions across Commit Check, commitlint, YACC, and DIY approaches, with supporting footnote explanations adjusted to match the revised content and references.

Changes

Why Commit Check? Comparison Table Update

Layer / File(s) Summary
Updated feature comparison table and footnotes
README.rst		 Expands the feature comparison matrix from a simplified layout to a comprehensive four-column structure with seventeen feature dimensions. Includes updates to checkmark/label assignments for each tool and clarifications to supporting footnote text explaining commitlint configuration delivery and YACC capabilities.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~15 minutes

Possibly related PRs

  • commit-check/commit-check#390: Previously modified the same "Why Commit Check?" comparison table with updates to feature rows, DIY/tool-dependent entries, and signed-off-by terminology.

Poem

A table grows wise with each row,
Comparing the tools that we know,
Four columns shine bright,
Features aligned just right,
The docs have more depth now to show 🐰✨

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/improve-comparison-table

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 15, 2026
@shenxianpeng
docs: improve Why Commit Check comparison table
a633ad6 
- Fix commitlint signed-off-by: change from ✅ to Partial (requires community plugin)
- Add YACC (Yet Another Commit Checker) column for complete competitive landscape
- Add 3 new comparison rows: Open source & free, Client-side enforcement, AI-native
- Fix YACC author validation, co-author ignore, org-level config based on official docs
- Add footnotes for commitlint signed-off-by, YACC context, and YACC ignore semantics
@shenxianpeng shenxianpeng force-pushed the chore/improve-comparison-table branch from 495b965 to a633ad6 Compare May 15, 2026 23:51
shenxianpeng
shenxianpeng commented May 15, 2026
View reviewed changes
Comment thread README.rst Outdated
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 15, 2026

Quality Gate Passed Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

@shenxianpeng shenxianpeng merged commit 284c6df into main May 15, 2026
10 of 11 checks passed
@shenxianpeng shenxianpeng deleted the chore/improve-comparison-table branch May 15, 2026 23:53
@coderabbitai coderabbitai Bot mentioned this pull request May 29, 2026
Merged
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

documentation Improvements or additions to documentation

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@shenxianpeng