Skip to content

Commit e8435e1

Browse files
authored
docs: show the v2.20.4 failure output on the org profile (#76)
1 parent a3d1f45 commit e8435e1

1 file changed

Lines changed: 12 additions & 10 deletions

File tree

‎profile/README.md‎

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,12 @@ Catch bad commits before they merge — one config file, from your commit hook t
2424
## What it looks like
2525

2626
```text
27-
CC001 message check failed ==> updated the parser
28-
The commit message should follow Conventional Commits. See https://www.conventionalcommits.org
29-
Suggest: Use <type>(<scope>): <description>, where <type> is one of: feat, fix, docs, ...
30-
Docs: https://commit-check.com/rules/#cc001
27+
✖ Commit rejected by Commit Check · 1 check failed
28+
29+
✖ CC001 message failed: updated the parser
30+
The commit message should follow Conventional Commits. See https://www.conventionalcommits.org
31+
Suggest: Use <type>(<scope>): <description>, where <type> is one of: feat, fix, docs, style, refactor, test, chore, perf, build, ci
32+
Docs: https://commit-check.com/rules/#cc001
3133
```
3234

3335
Every failure names a **stable rule ID**, the value that failed, what to do
@@ -58,18 +60,18 @@ accepted?"* gets the answer your maintainers actually configured.
5860
Nothing to configure to begin with: the defaults enforce Conventional Commits,
5961
Conventional Branch, and sane subject lengths.
6062

61-
On GitHub, the quickest start is the **[Commit Check App](https://github.com/apps/commit-check)**:
62-
install it on your organization or account, and every push and pull request
63-
gets a check run, with no workflow file. It is free for public repositories and
64-
personal accounts.
63+
On GitHub, the quickest start is the **[Commit Check App](https://github.com/apps/commit-check)**.
64+
Install it on your organization or account, and every push to a branch and every
65+
pull request gets a check run, with no workflow file. It is free for public
66+
repositories and personal accounts.
6567

6668
To run the checks yourself instead:
6769

6870
```yaml
6971
# .pre-commit-config.yaml — feedback while the message is still being written
7072
repos:
7173
- repo: https://github.com/commit-check/commit-check
72-
rev: v2.19.2
74+
rev: v2.20.4
7375
hooks:
7476
- id: check-message
7577
- id: check-branch
@@ -91,7 +93,7 @@ Every rule and option is at **[commit-check.com](https://commit-check.com)**.
9193
9294
| Project | What it is | Use it for |
9395
| --- | --- | --- |
94-
| [**Commit Check App**](https://github.com/apps/commit-check) | GitHub App | Org-wide checks with no workflow file, on every push and pull request |
96+
| [**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 |
9597
| [**commit-check**](https://github.com/commit-check/commit-check) | Python CLI & pre-commit hook | Local checks, CI pipelines, scripting |
9698
| [**commit-check-action**](https://github.com/commit-check/commit-check-action) | GitHub Action | PR & push validation, job summaries, PR comments |
9799
| [**commit-check-mcp**](https://github.com/commit-check/commit-check-mcp) | Model Context Protocol server | Letting AI agents validate against your rules |

0 commit comments

Comments
 (0)