Skip to content

Commit 0264f70

Browse files
authored
docs: show the AI checks in the README (#328)
Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>
1 parent b91c880 commit 0264f70

1 file changed

Lines changed: 26 additions & 3 deletions

File tree

‎README.md‎

Lines changed: 26 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,9 +23,10 @@
2323

2424
The GitHub Action for [Commit Check](https://github.com/commit-check/commit-check),
2525
commit policy as code for teams and AI agents. It checks every commit of a pull
26-
request — message, branch, author, and optionally the PR title — against your
27-
`cchk.toml`, and reports the result in the job summary, as annotations on the
28-
diff and, if you want, as a PR comment.
26+
request — message, branch, author, and optionally the PR title and the AI
27+
attribution in its description — against your `cchk.toml`, and reports the
28+
result in the job summary, as annotations on the diff and, if you want, as a PR
29+
comment. It can also label the pull requests that AI tools wrote.
2930

3031
## Usage
3132

@@ -160,6 +161,28 @@ The step log prints the same tree, plus one annotation per finding on the
160161
Files changed tab. With `pr-comments: true` the same report is posted to the
161162
pull request, and later runs edit that one comment instead of adding more.
162163

164+
With `pr-body-ai-attribution: true` and `ai_attribution = "forbid"`, a
165+
description that credits an AI co-author fails the same way, and the report
166+
names the line to remove:
167+
168+
> ❌ **1 of 2 checks failed**
169+
>
170+
> | Scope | Checked value | Failed checks |
171+
> |---|---|---|
172+
> | PR description | `Claude Code` | [CC013 ai-attribution](https://commit-check.com/rules/#cc013) |
173+
>
174+
> ```text
175+
> PR description
176+
> ✖ PR description (1 failure)
177+
> CC013 ai-attribution
178+
> value: Claude Code
179+
> AI attribution is forbidden in this project — detected: Claude Code
180+
> Suggest: In the description, remove "Co-Authored-By: Claude <noreply@anthropic.com>"
181+
> ```
182+
183+
With `ai-label: true`, a pull request an AI tool wrote also gets the
184+
`ai-assisted` label.
185+
163186
## Outputs
164187

165188
### `result`

0 commit comments

Comments
 (0)