[shenxianpeng]

What

The README did not mention the AI checks until the Inputs table. Two small additions:

1. The intro paragraph names the AI attribution check on the PR description and the AI label.
2. "What it looks like" gets a second, short example: a description that credits an AI co-author, under ai_attribution = "forbid".

Before / after

Intro, before:

It checks every commit of a pull request — message, branch, author, and optionally the PR title — against your cchk.toml, …

After:

It checks every commit of a pull request — message, branch, author, and optionally the PR title and the AI attribution in its description — against your cchk.toml, … It can also label the pull requests that AI tools wrote.

New example (copied from a real run of main.py with commit-check 2.20.2):

❌ 1 of 2 checks failed

Scope	Checked value	Failed checks
PR description	Claude Code	CC013 ai-attribution

PR description
  ✖ PR description (1 failure)
      CC013 ai-attribution
        value: Claude Code
        AI attribution is forbidden in this project — detected: Claude Code
        Suggest: In the description, remove "Co-Authored-By: Claude <noreply@anthropic.com>"

Written as Markdown like the existing example, so it reads in dark mode and stays searchable.

[coderabbitai]

Warning

Review limit reached

You've used all free OSS reviews for now. Wait for the free limit to reset to keep reviewing this public repository.

Next included review available in 59 minutes.

Check out review usage here.

View limit details

Limit details: You’ve used the included review currently available.

Learn how review limits work.

Review configuration:

Run configuration

• Source mode: Auto
• Repository: Unavailable
• Branch: Unavailable
• File: No configuration file from this repository applied
• Commit: Unavailable
• Layers: defaults
• Review profile: CHILL
• Plan: Advanced
• Run ID: 2f88e59e-6944-43fb-8cc3-13c74a0f0409

Commits

Reviewing files that changed from the base of the PR and between 5aa913a and c8ddb7a.

Files selected for processing: 1

• README.md

• Autofix · Keep fixing CodeRabbit findings and required CI, and resolving merge conflicts

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

Share

• X
• Mastodon
• Reddit
• LinkedIn

[github-actions]

Commit Check

✅ All 5 checks passed

Show all 5 checks

Commit message
  ✔ PR title (docs: show the AI checks in the README)
  ✔ Commit 1/1 (c8ddb7a) (docs: show the AI checks in the README)
Branch
  ✔ Branch (docs/readme-ai-example)
Author
  ✔ Author name (Xianpeng Shen)
  ✔ Author email (3353385+shenxianpeng@users.noreply.github.com)

commit-check 2.20.2 · Rules reference

[codecov]

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (5aa913a) to head (c8ddb7a).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files

@@            Coverage Diff            @@
##              main      #328   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            1         1           
  Lines          791       791           
=========================================
  Hits           791       791           

Flag	Coverage Δ
unittests	100.00% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.