From a98df2fcfbdc0ce26bb7533640c5537596392f2c Mon Sep 17 00:00:00 2001 From: shenxianpeng Date: Mon, 27 Jul 2026 06:50:34 +0000 Subject: [PATCH 1/7] docs: revamp org profile as a product family overview Present Commit Check as a cohesive product family with a clear value proposition, the CLI/Action/MCP/App lineup, key features, and trust signals (SLSA Level 3, notable adopters, license). --- profile/README.md | 72 ++++++++++++++++++++++++++++++++++++++--------- 1 file changed, 58 insertions(+), 14 deletions(-) diff --git a/profile/README.md b/profile/README.md index d12b81d..8dcf278 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,26 +1,70 @@ +
+ +Commit Check + # Commit Check -[![Website](https://img.shields.io/static/v1?label=Website&message=commit-check.github.io&color=2c9ccd&logo=git&logoColor=white)](https://commit-check.github.io) +**Clean commits. Clear standards.** + +Enforce commit message, branch naming, author, and signoff standards — +one policy, across your CLI, pre-commit, CI, and AI agents. + +[![PyPI](https://img.shields.io/pypi/v/commit-check?logo=pypi&logoColor=white&color=2c9ccd)](https://pypi.org/project/commit-check/) +[![Downloads](https://img.shields.io/pypi/dm/commit-check?color=2c9ccd)](https://pypi.org/project/commit-check/) +[![Marketplace](https://img.shields.io/badge/Marketplace-commit--check--action-2c9ccd?logo=githubactions&logoColor=white)](https://github.com/marketplace/actions/commit-check-action) +[![SLSA 3](https://slsa.dev/images/gh-badge-level3.svg)](https://slsa.dev) +[![License: MIT](https://img.shields.io/badge/License-MIT-2c9ccd.svg)](https://opensource.org/licenses/MIT) +[![Website](https://img.shields.io/badge/Docs-commit--check.github.io-2c9ccd?logo=git&logoColor=white)](https://commit-check.github.io) + +
+ +--- + +## Why Commit Check + +**Commit Check** (aka **cchk**) is an open-source policy engine for Git commit +metadata — commit messages, branch names, committer name/email, signoff, and +more — helping teams keep a **consistent, compliant, and clean Git history**. + +Define your rules once in a single versioned config, and enforce them +identically everywhere: on a developer's machine, in CI, and in AI-assisted +workflows. -**Clean commits. Clear standards.** +It's a lightweight, open alternative to GitHub Enterprise +[metadata restrictions](https://docs.github.com/en/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#metadata-restrictions) +and Bitbucket's paid +[Yet Another Commit Checker](https://marketplace.atlassian.com/apps/1211854/yet-another-commit-checker?tab=overview&hosting=datacenter), +built for a modern DevOps and Infrastructure-as-Code workflow. -Automate commit and branch validation — simple, consistent, and configurable. +## The Commit Check family -## About Commit Check +| Project | What it is | Use it for | +| --- | --- | --- | +| [**commit-check**](https://github.com/commit-check/commit-check) | Python CLI & pre-commit hook | Local checks, CI pipelines, scripting | +| [**commit-check-action**](https://github.com/commit-check/commit-check-action) | GitHub Action | PR & push validation, job summaries, PR comments | +| [**commit-check-mcp**](https://github.com/commit-check/commit-check-mcp) | Model Context Protocol server | Letting AI agents validate against your rules | +| **commit-check-app** | GitHub App | Zero-config, org-wide checks *(coming soon)* | -**Commit Check** (aka **cchk**) is an open-source tool that enforces **commit metadata standards** — including commit messages, branch naming, committer name/email, commit signoff, and more — helping teams maintain **consistency, compliance, and a clean Git history.** +## Key features -As a lightweight alternative to GitHub Enterprise [Metadata restrictions](https://docs.github.com/en/enterprise-server@3.11/repositories/configuring-branches-and-merges-in-your-repository/managing-rulesets/available-rules-for-rulesets#metadata-restrictions) and Bitbucket's paid plugin [Yet Another Commit Checker](https://marketplace.atlassian.com/apps/1211854/yet-another-commit-checker?tab=overview&hosting=datacenter), Commit Check integrates DevOps principles and Infrastructure as Code (IaC) practices for a modern workflow. +- ✅ **Conventional Commits** & **Conventional Branch** enforcement +- ✅ **Author** name / email validation with configurable patterns +- ✅ **Signoff (DCO)** verification +- ✅ **Rebase / merge-base** and **force-push** safety checks +- ✅ **AI attribution governance** — detect or forbid AI-generated commit trailers +- ✅ **One config** (`cchk.toml`), with org-level inheritance, shared across CLI, pre-commit & CI +- ✅ **Job summaries & PR comments**, plus **JSON output** and **MCP tools** for automation and AI agents -## Getting Started +## Trusted & secure -* [commit-check](https://github.com/commit-check/commit-check) running as CLI or pre-commit hook. -* [commit-check-action](https://github.com/commit-check/commit-check-action) running as GitHub Action. -* [commit-check-mcp](https://github.com/commit-check/commit-check-mcp) running as MCP server. +- 🔒 **SLSA Level 3** build provenance, with artifact attestation verified at install time +- 🏢 Used by teams at **Apache**, **Texas Instruments**, **Mila**, and [many more](https://github.com/commit-check/commit-check-action/network/dependents) +- 📖 **MIT licensed**, actively maintained, and following [Conventional Commits](https://www.conventionalcommits.org/) and [Conventional Branch](https://conventional-branch.github.io/) -## Contributing 💪 +## Get involved -We welcome feedback, bug reports, and feature requests from the community. Join us in making Commit Check better! +We welcome feedback, bug reports, and feature requests from the community. -* [Issues](https://github.com/commit-check/commit-check/issues) — bug reports, feature requests -* [Discussions](https://github.com/commit-check/commit-check/discussions) — questions, ideas, community conversations +- [Issues](https://github.com/commit-check/commit-check/issues) — bug reports & feature requests +- [Discussions](https://github.com/commit-check/commit-check/discussions) — questions, ideas, and community conversations +- [Documentation](https://commit-check.github.io) — guides, configuration reference, and more From db03b309989719c036e710e01033f1d2911393e4 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Mon, 27 Jul 2026 10:14:08 +0300 Subject: [PATCH 2/7] chore: Comment out commit-check-app entry in README Commented out the commit-check-app entry in the README. --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 8dcf278..2a00d20 100644 --- a/profile/README.md +++ b/profile/README.md @@ -43,7 +43,7 @@ built for a modern DevOps and Infrastructure-as-Code workflow. | [**commit-check**](https://github.com/commit-check/commit-check) | Python CLI & pre-commit hook | Local checks, CI pipelines, scripting | | [**commit-check-action**](https://github.com/commit-check/commit-check-action) | GitHub Action | PR & push validation, job summaries, PR comments | | [**commit-check-mcp**](https://github.com/commit-check/commit-check-mcp) | Model Context Protocol server | Letting AI agents validate against your rules | -| **commit-check-app** | GitHub App | Zero-config, org-wide checks *(coming soon)* | + ## Key features From c7a681890923827ec5accfdbad03968fc5744ea7 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Mon, 27 Jul 2026 10:15:45 +0300 Subject: [PATCH 3/7] chore: Increase logo width in README.md Updated logo size in README.md from 110 to 200 pixels. --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 2a00d20..9cde02d 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,6 +1,6 @@
-Commit Check +Commit Check # Commit Check From 3dd2160c57f13fff83c61585933a0d40f6eaeac2 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Mon, 27 Jul 2026 10:16:05 +0300 Subject: [PATCH 4/7] chore: Change logo width from 200 to 400 Updated logo image size in README. --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 9cde02d..cda219e 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,6 +1,6 @@
-Commit Check +Commit Check # Commit Check From fcbf991dc72eac9743f15a22088e489d50b1f5dd Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Mon, 27 Jul 2026 10:20:31 +0300 Subject: [PATCH 5/7] chore: Update logo image in README.md --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index cda219e..01cf32d 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,6 +1,6 @@
-Commit Check +Commit Check # Commit Check From 5026220e68dfa21e7eacbede5aa46bbe50b73a71 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Mon, 27 Jul 2026 10:20:56 +0300 Subject: [PATCH 6/7] chore: Reduce logo size in profile README Updated logo size in README from 400px to 300px. --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 01cf32d..614649a 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,6 +1,6 @@
-Commit Check +Commit Check # Commit Check From 2b899f5a8e3563e83411fa94b3ec6cda4dd5861b Mon Sep 17 00:00:00 2001 From: Xianpeng Shen Date: Mon, 27 Jul 2026 10:21:12 +0300 Subject: [PATCH 7/7] chore: Change logo width in README Updated logo size in README from 300 to 200 pixels. --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 614649a..6e77c33 100644 --- a/profile/README.md +++ b/profile/README.md @@ -1,6 +1,6 @@
-Commit Check +Commit Check # Commit Check