From afa859783c46d099bdc08936b46dde569f76233b Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Fri, 29 May 2026 08:20:56 +0300 Subject: [PATCH] docs: sharpen README first screen with lightweight policy engine framing Replace the 'most comprehensive' claim with a more credible, professional positioning: Commit Check as a lightweight policy engine for Git commit metadata. Add three core differentiators directly on the first screen: - One policy file (cchk.toml) - Multiple enforcement points (CLI, pre-commit, CI / GitHub Actions) - Machine-readable output (JSON + Python API) All claims verified against the current codebase: - 5 validation categories and 18+ rules (rules_catalog.py) - --format json (main.py:157) - commit_check.api with validate_message/branch/author/push/all (api.py) - 5 pre-commit hooks (.pre-commit-hooks.yaml) --- README.rst | 11 ++++++++--- 1 file changed, 8 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index c94ac62d..18d91d64 100644 --- a/README.rst +++ b/README.rst @@ -39,10 +39,15 @@ Commit Check Overview -------- -**Commit Check** (aka **cchk**) is the most comprehensive open-source tool for enforcing Git commit standards — including commit messages, branch naming, author identity, commit signoff, and more — helping teams maintain consistency and compliance across every repository. +**Commit Check** is a lightweight policy engine for Git commit metadata. -As a lightweight, free alternative to GitHub Enterprise `Metadata restrictions `_ -and Bitbucket's paid `Yet Another Commit Checker `_ plugin, Commit Check integrates DevOps principles and Infrastructure as Code (IaC) practices for a modern workflow. +It validates commit messages, branch names, author identity, signoff trailers, +and push safety — using one versioned TOML policy across local hooks, CI, +GitHub Actions, and AI automation. + +- **One policy file:** ``cchk.toml`` +- **Multiple enforcement points:** CLI, pre-commit, CI / GitHub Actions +- **Machine-readable output:** JSON + Python API for automation and AI agents .. image:: https://github.com/commit-check/commit-check/raw/main/docs/demo.gif :alt: commit-check demo