Skip to content

docs: update comparison table in README #390

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 2 commits into from
Apr 4, 2026
Merged

docs: update comparison table in README #390

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4191c6c
docs: Remove SLSA badge and update comparison table in README
shenxianpeng Apr 4, 2026
fecadb9
docs: Update README to clarify signed-off-by trailer enforcement
shenxianpeng Apr 4, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
58 changes: 30 additions & 28 deletions README.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,10 +21,6 @@ Commit Check
:target: https://github.com/commit-check/commit-check
:alt: commit-check

.. |slsa-badge| image:: https://slsa.dev/images/gh-badge-level3.svg
:target: https://slsa.dev
:alt: SLSA

.. |pypi-downloads| image:: https://img.shields.io/pypi/dm/commit-check?color=%232c9ccd
:target: https://pypi.org/project/commit-check/
:alt: PyPI Downloads
Expand All @@ -33,7 +29,7 @@ Commit Check
:target: https://pypi.org/project/commit-check/
:alt: Python Versions

|ci-badge| |sonar-badge| |pypi-version| |pypi-downloads| |python-versions| |commit-check-badge| |codecov-badge| |slsa-badge|
|ci-badge| |sonar-badge| |pypi-version| |pypi-downloads| |python-versions| |commit-check-badge| |codecov-badge|

Overview
--------
Expand All @@ -45,62 +41,68 @@ and Bitbucket's paid `Yet Another Commit Checker <https://marketplace.atlassian.

**Why Commit Check?**

The table below compares common approaches to commit policy enforcement.
``commitlint`` is a specialized commit-message linter. Custom Git hooks and
the ``pre-commit`` framework are integration mechanisms, so the last column
reflects a DIY approach rather than built-in product features.

.. list-table::
:header-rows: 1
:widths: 40 20 20 20
:widths: 36 18 18 28

* - Feature
- Commit Check ✅
- commitlint
- pre-commit hooks
- Custom hooks
* - Conventional Commits enforcement
- ✅
- ✅
- ✅
- DIY
* - Branch naming validation
- ✅
- ❌
- Partial
- DIY
* - Author name / email validation
- ✅
- ❌
- ❌
* - Signoff / DCO check
- DIY
* - Signed-off-by trailer enforcement
- ✅
- ❌
- ❌
- ✅
- DIY
* - Co-author ignore list
- ✅
- ❌
- ❌
* - Organization-level config inheritance
- DIY
* - Organization-level shared config
- ✅
- ❌
- ❌
- ✅
- DIY
* - Zero-config defaults
- ✅
- ❌
- ❌
* - Works without Node.js
- ✅
- ❌
- ✅
* - TOML configuration
- Depends
* - Native TOML configuration
- ✅
- ❌
- Depends
* - Git hook / pre-commit integration
- ✅
* - pre-commit framework integration
- ✅
- ✅
- Partial
- ✅
* - CI/CD environment variables
* - CI/CD-friendly configuration
- ✅
- Partial
- ❌
* - SLSA Level 3 supply chain security
- ✅
- ❌
- ❌
- DIY

For ``commitlint``, organization-level shared config is typically delivered via
shareable config packages or local files. ``DIY`` means you can implement a
capability with custom Git hooks or ``pre-commit`` scripts, but it is not
provided as a turnkey policy layer.

Installation
------------
Expand Down
Loading