Skip to content

docs: show the v2.20.4 failure output on the org profile #76

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 5 commits into from
Nov 11, 2026
Merged

docs: show the v2.20.4 failure output on the org profile #76

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
db1d51e
docs: put the GitHub App first on the org profile
shenxianpeng Oct 20, 2026
a16351d
docs: say the App checks pushes to a branch
shenxianpeng Oct 20, 2026
ffd1969
chore: merge main into the profile branch
shenxianpeng Nov 10, 2026
2728e27
docs: show the v2.20.4 failure output on the org profile
shenxianpeng Nov 10, 2026
f2269b5
docs: say branch push in the family table too
shenxianpeng Nov 10, 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
22 changes: 12 additions & 10 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <type>(<scope>): <description>, where <type> 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 <type>(<scope>): <description>, where <type> 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
Expand Down Expand Up @@ -58,18 +60,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.
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:

```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.2
rev: v2.20.4
hooks:
- id: check-message
- id: check-branch
Expand All @@ -91,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 |
Expand Down
Loading