From db1d51ec7f78038c05274eecff21f635e389261f Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Tue, 20 Oct 2026 16:56:30 +0000 Subject: [PATCH 1/4] docs: put the GitHub App first on the org profile The App installs today and needs no workflow file, so the profile now offers it first: the quick start opens with the install link, the family table lists the App first, and the diagram's CI column reads "GitHub App or Action". The pre-commit example pins v2.19.2, the current release. --- profile/README.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/profile/README.md b/profile/README.md index 4cc2a8d..1ca9811 100644 --- a/profile/README.md +++ b/profile/README.md @@ -41,8 +41,8 @@ comment, or an MCP tool call. │ ┌─────────────────┼─────────────────┬─────────────────┐ ▼ ▼ ▼ ▼ - your machine pre-commit GitHub CI AI agents - (commit-check) hook Action (MCP) + your machine pre-commit GitHub App AI agents + (commit-check) hook or Action (MCP) │ │ │ │ └─────────────────┴────────┬────────┴─────────────────┘ ▼ @@ -58,11 +58,18 @@ accepted?"* gets the answer your maintainers actually configured. Nothing to configure to begin with: the defaults enforce Conventional Commits, Conventional Branch, and sane subject lengths. +On GitHub, the quickest start is the **[Commit Check App](https://github.com/apps/commit-check)**: +install it on your organization or account, and every push and pull request +gets a check run, with no workflow file. It is free for public repositories and +personal accounts. + +To run the checks yourself instead: + ```yaml # .pre-commit-config.yaml — feedback while the message is still being written repos: - repo: https://github.com/commit-check/commit-check - rev: v2.19.1 + rev: v2.19.2 hooks: - id: check-message - id: check-branch @@ -84,10 +91,10 @@ Every rule and option is at **[commit-check.com](https://commit-check.com)**. | Project | What it is | Use it for | | --- | --- | --- | +| [**Commit Check App**](https://github.com/apps/commit-check) | GitHub App | Org-wide checks with no workflow file, on every push and pull request | | [**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**](https://github.com/apps/commit-check) | GitHub App | Org-wide checks with no workflow file, on every push and pull request | ## What it does not do From a16351dca4774cd09c27a35b96d41ffb00797d4a Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Tue, 20 Oct 2026 17:08:14 +0000 Subject: [PATCH 2/4] docs: say the App checks pushes to a branch --- profile/README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/profile/README.md b/profile/README.md index 1ca9811..c5d6e41 100644 --- a/profile/README.md +++ b/profile/README.md @@ -58,10 +58,10 @@ accepted?"* gets the answer your maintainers actually configured. Nothing to configure to begin with: the defaults enforce Conventional Commits, Conventional Branch, and sane subject lengths. -On GitHub, the quickest start is the **[Commit Check App](https://github.com/apps/commit-check)**: -install it on your organization or account, and every push and pull request -gets a check run, with no workflow file. It is free for public repositories and -personal accounts. +On GitHub, the quickest start is the **[Commit Check App](https://github.com/apps/commit-check)**. +Install it on your organization or account, and every push to a branch and every +pull request gets a check run, with no workflow file. It is free for public +repositories and personal accounts. To run the checks yourself instead: From 2728e2759df83f6a060cf2b376630d72e4867317 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Tue, 10 Nov 2026 23:01:38 +0000 Subject: [PATCH 3/4] docs: show the v2.20.4 failure output on the org profile The sample under "What it looks like" was the output of v2.20.2 and earlier. It is now what 2.20.4 prints for the same message, and the pre-commit snippet pins v2.20.4 instead of v2.19.2. --- profile/README.md | 12 +++++++----- 1 file changed, 7 insertions(+), 5 deletions(-) diff --git a/profile/README.md b/profile/README.md index 68d232c..8e59f66 100644 --- a/profile/README.md +++ b/profile/README.md @@ -24,10 +24,12 @@ Catch bad commits before they merge — one config file, from your commit hook t ## What it looks like ```text -CC001 message check failed ==> updated the parser -The commit message should follow Conventional Commits. See https://www.conventionalcommits.org -Suggest: Use (): , where is one of: feat, fix, docs, ... -Docs: https://commit-check.com/rules/#cc001 +✖ Commit rejected by Commit Check · 1 check failed + +✖ CC001 message failed: updated the parser + The commit message should follow Conventional Commits. See https://www.conventionalcommits.org + Suggest: Use (): , where is one of: feat, fix, docs, style, refactor, test, chore, perf, build, ci + Docs: https://commit-check.com/rules/#cc001 ``` Every failure names a **stable rule ID**, the value that failed, what to do @@ -69,7 +71,7 @@ To run the checks yourself instead: # .pre-commit-config.yaml — feedback while the message is still being written repos: - repo: https://github.com/commit-check/commit-check - rev: v2.19.2 + rev: v2.20.4 hooks: - id: check-message - id: check-branch From f2269b5aef44a94d0e6609a9487cdb15ebbba2a4 Mon Sep 17 00:00:00 2001 From: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com> Date: Tue, 10 Nov 2026 23:09:15 +0000 Subject: [PATCH 4/4] docs: say branch push in the family table too --- profile/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/profile/README.md b/profile/README.md index 8e59f66..da067b5 100644 --- a/profile/README.md +++ b/profile/README.md @@ -93,7 +93,7 @@ Every rule and option is at **[commit-check.com](https://commit-check.com)**. | Project | What it is | Use it for | | --- | --- | --- | -| [**Commit Check App**](https://github.com/apps/commit-check) | GitHub App | Org-wide checks with no workflow file, on every push and pull request | +| [**Commit Check App**](https://github.com/apps/commit-check) | GitHub App | Org-wide checks with no workflow file, on every branch push and pull request | | [**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 |