Skip to content

docs: add commit-check vs GitHub Rulesets comparison table#419

Merged
shenxianpeng merged 3 commits into
mainfrom
chore/add-comparison-page
May 29, 2026
Merged

docs: add commit-check vs GitHub Rulesets comparison table#419
shenxianpeng merged 3 commits into
mainfrom
chore/add-comparison-page

Conversation

@shenxianpeng
Copy link
Copy Markdown
Member

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

Summary

Adds a new documentation page comparing commit-check with the two most common alternatives users ask about: commitlint and GitHub Rulesets.

What's in it

commit-check vs commitlint

  • Feature-by-feature comparison table (16 rows)
  • Honest positioning: commitlint is the standard (18.6k stars), commit-check is a broader policy layer
  • "Use commitlint if / Use commit-check if" decision guide

commit-check vs GitHub Rulesets

  • Feature comparison table (14 rows)
  • Does NOT pretend GitHub can't do things — accurately lists what Rulesets support (branch name regex, author email, etc.)
  • Positions them as complementary: Rulesets = platform-native server gating, commit-check = portable local-first validation
  • ASCII workflow diagram showing how both fit together

Key messaging

  • GitHub Rulesets are platform-native enforcement. commit-check is portable, config-as-code, local-first, and usable before code reaches GitHub.

Files changed

  • docs/compare.rst — new page
  • docs/index.rst — add to toctree

Fact-checking done

  • commitlint stars/forks verified via GitHub API
  • commitlint v21.0.1 release date verified
  • @commitlint/format API verified (returns string[], no JSON)
  • GitHub Rulesets metadata restrictions verified (regex for branch/tag names, commit messages, author email)
  • GitHub Rulesets push ruleset availability (Team/Enterprise plans) verified

Summary by CodeRabbit

  • Documentation
    • Expanded the comparison table to include GitHub Rulesets alongside commitlint, YACC, and custom hooks
    • Added explanatory details about GitHub Rulesets capabilities and limitations
    • Updated documentation footnotes with expanded references

Review Change Stack

@shenxianpeng
docs: add commit-check vs commitlint vs GitHub Rulesets comparison page
14e52e7 
- Feature-by-feature comparison tables for both commitlint and GitHub Rulesets
- Honest positioning: commitlint is the standard, commit-check is broader
- GitHub Rulesets are complementary, not competitive (platform vs portable)
- 'Use commitlint if / Use commit-check if' decision guide
- ASCII workflow diagram showing how all three fit together
@shenxianpeng shenxianpeng requested a review from a team as a code owner May 29, 2026 05:45
@netlify
Copy link
Copy Markdown

netlify Bot commented May 29, 2026 •
edited
Loading

✅ Deploy Preview for commit-check ready!

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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label May 29, 2026
@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented May 29, 2026 •
edited
Loading

📝 Walkthrough

Walkthrough

Updated the README.rst "Why Commit Check?" comparison table to add GitHub Rulesets alongside commitlint, YACC, and Custom hooks. Added explanatory text documenting GitHub Rulesets' regex-based metadata enforcement and plan requirements, plus expanded footnotes clarifying its limitations compared to Conventional Commits-aware tools.

Changes

GitHub Rulesets Comparison Documentation

Layer / File(s) Summary
GitHub Rulesets comparison table, explanation, and footnotes
README.rst		 Expanded the feature comparison matrix to include GitHub Rulesets, detailing how push rulesets enforce metadata using regex patterns (branch/tag names, commit messages, author email) with caveats around Conventional Commits semantics awareness, server-side-only enforcement, GitHub plan requirements, and lack of local pre-commit validation feedback.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Possibly related PRs

  • commit-check/commit-check#413: Modifies the same "Why Commit Check?" comparison table and README footnotes to adjust YACC/commitlint entries and feature matrix values.
  • commit-check/commit-check#390: Updates the "Why Commit Check?" comparison table in README.rst, adjusting columns and per-feature comparison values.

Poem

🐰 A table once simple, now rulesets arise,
GitHub's regex powers meet keen rabbit eyes,
Footnotes expand with the truth of the tool—
Local beats server, that's Commit Check's rule! 🌿

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
Title check ✅ Passed The PR title accurately reflects the main change: adding a GitHub Rulesets comparison to the existing comparison table in README.rst.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch chore/add-comparison-page

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.

coderabbitai[bot]
coderabbitai Bot reviewed May 29, 2026
View reviewed changes
Copy link
Copy Markdown
Contributor

@coderabbitai coderabbitai Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents 
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@docs/compare.rst`:
- Around line 186-193: The ASCII workflow box is misaligned: ensure every inner
line between the opening and closing vertical bars (the lines starting with "│"
and ending with "│") has the same total width as the top and bottom borders
("┌─────────────────────────────────────────────┐" and
"└─────────────────────────────────────────────┘"); adjust spacing inside the
lines containing "Your Workflow", "[Editor] ──► [pre-commit] ──► [git push] ──►
[GitHub]", the two indented lines ("commit-check (local feedback)" and "GitHub
Rulesets (server gating)"), and the empty padding lines so each line's content
plus surrounding spaces equals the box inner width, preserving the box-drawing
characters and alignment.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: 6917f666-3a34-44ff-aa6b-0c89e36e8542

📥 Commits

Reviewing files that changed from the base of the PR and between 7a66c84 and 14e52e7.

📒 Files selected for processing (2)
  • docs/compare.rst
  • docs/index.rst

Comment thread docs/compare.rst Outdated
@shenxianpeng
docs: add GitHub Rulesets to README comparison; deduplicate docs/comp…
9eb86b5 
…are.rst

- Add GitHub Rulesets column to the existing Why Commit Check? feature matrix in README
- Add footnotes explaining GitHub Rulesets regex-based enforcement and plan requirements
- Trim docs/compare.rst: remove overlapping commitlint table, keep decision guide + workflow
- docs/compare.rst now links to README matrix as the canonical feature comparison
@shenxianpeng
docs: remove compare page; consolidate into README table
eb36191 
- Delete docs/compare.rst (redundant with README 'Why Commit Check?' table)
- Remove compare from docs/index.rst toctree
- README table: fix GitHub Rulesets 'Zero-config defaults' ❌ (not ✅)
- Renumber footnotes after removing compare page link
- All GitHub Rulesets info now lives in the single README feature matrix
@sonarqubecloud
Copy link
Copy Markdown

sonarqubecloud Bot commented May 29, 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 changed the title docs: add commit-check vs commitlint vs GitHub Rulesets comparison page docs: add commit-check vs GitHub Rulesets comparison page May 29, 2026
@shenxianpeng shenxianpeng changed the title docs: add commit-check vs GitHub Rulesets comparison page docs: add commit-check vs GitHub Rulesets comparison table May 29, 2026
@shenxianpeng shenxianpeng merged commit 4b0e6ae into main May 29, 2026
12 checks passed
@shenxianpeng shenxianpeng deleted the chore/add-comparison-page branch May 29, 2026 06:00
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@coderabbitai coderabbitai[bot] coderabbitai[bot] left review comments

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