Skip to content

docs(blog): add three articles introducing commit-check#6

Merged
shenxianpeng merged 5 commits into
mainfrom
claude/three-articles-pr-0rjdvy
Jun 21, 2026
Merged

docs(blog): add three articles introducing commit-check#6
shenxianpeng merged 5 commits into
mainfrom
claude/three-articles-pr-0rjdvy

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Jun 21, 2026

Copy link
Copy Markdown
Member

Adds three blog posts to docs/blog/posts/ for the commit-check site.

Articles

  1. One policy file for your Git history (introducing-commit-check.md)
    — overview of commit-check as a lightweight policy engine for Git
    metadata; one cchk.toml, enforced across CLI / pre-commit / CI; zero-config
    defaults and the enabled badge.

  2. From zero-config to org-wide policy (configuring-commit-check.md)
    — configuration priority (CLI args → CCHK_* env → config file), a real
    cchk.toml, SchemaStore IDE autocompletion, CLI/env overrides,
    inherit_from for org-wide config, and pre-push force-push safety.

  3. AI-native: JSON output and a Python API (ai-native-commit-check.md)
    --format json structured output with error/suggest for agent
    self-correction, --no-banner / --compact quieter modes, and the
    commit_check.api Python interface.

All content is drawn from the current project README and cchk.toml. Each post
uses the existing blog frontmatter format (date, categories, tags, author
shenxianpeng).

🤖 Generated with Claude Code


Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Added blog post introducing Commit Check and its policy-driven workflow.
    • Added configuration guide for setting up rules across CLI, environment variables, and cchk.toml with sharing via inheritance.
    • Added AI-native Commit Check post, including --format json structured output and an in-process Python API.
    • Updated site navigation to enable the Blog section and included blog pages in the build.

Add three blog posts for the commit-check site:
- One policy file for your Git history (overview / why commit-check)
- From zero-config to org-wide policy (configuration & inherit_from)
- AI-native: JSON output and a Python API (machine-readable usage)

Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com>
Claude-Session: https://claude.ai/code/session_01GDSwJ4o6by3HrzUSzhFLJG
@netlify

netlify Bot commented Jun 21, 2026

Copy link
Copy Markdown

Deploy Preview for commit-check-github-io ready!

Name Link
🔨 Latest commit 55c119b
🔍 Latest deploy log https://app.netlify.com/projects/commit-check-github-io/deploys/6a38442bdc93130008c3c1de
😎 Deploy Preview https://deploy-preview-6--commit-check-github-io.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify project configuration.

@coderabbitai

coderabbitai Bot commented Jun 21, 2026

Copy link
Copy Markdown

Review Change Stack

Warning

Review limit reached

@shenxianpeng, we couldn't start this review because you've reached your PR review rate limit.

More reviews will be available in 40 minutes and 33 seconds. Learn how PR review limits work.

Your organization has used up its prepaid credits, and credit purchases are no longer available. Enable the review add-on in the billing tab to keep reviews running — you're only billed for reviews past your plan's rate limits ($0.25/file).

⌛ How to resolve this issue?

After more reviews become available, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

To avoid repeated limits, reduce automatic review volume by pausing incremental auto-reviews earlier, using label-based review opt-in, excluding WIP or generated PR titles, or requesting reviews manually when the PR is ready. If your team needs uninterrupted high-volume reviews, an organization admin can enable usage-based credits.

🚦 How do rate limits work?

CodeRabbit enforces per-developer PR review limits for each organization. Most developers receive the normal plan refill rate.

For paid Pro and Pro+ PR reviews, CodeRabbit uses adaptive limits for sustained high-volume activity. When a developer's recent PR review activity reaches the 95th percentile or higher among CodeRabbit users, the refill rate gradually slows as usage increases. The highest same-day bursts are limited more strictly.

Please see our Fair Usage Limits Policy for further information.

ℹ️ Review info
⚙️ Run configuration

Configuration used: defaults

Review profile: CHILL

Plan: Pro

Run ID: c0a2bb82-8cc6-423a-a01b-991a3792d5b0

📥 Commits

Reviewing files that changed from the base of the PR and between 229075a and 55c119b.

📒 Files selected for processing (5)
  • docs/blog/posts/ai-native-commit-check.md
  • docs/blog/posts/configuring-commit-check.md
  • docs/blog/posts/introducing-commit-check.md
  • docs/blog/posts/myfirst.md
  • docs/blog/posts/mysecond.md
📝 Walkthrough

Walkthrough

Three new blog posts are added under docs/blog/posts/: an introduction to Commit Check as a Git metadata policy engine, a configuration guide covering resolution order, cchk.toml examples, inherit_from sharing, and push safety, and an AI-native post documenting the --format json CLI mode and the commit_check.api Python interface. The mkdocs.yml is updated to enable blog navigation and build visibility.

Changes

Commit Check Blog Post Series

Layer / File(s) Summary
Introducing Commit Check post
docs/blog/posts/introducing-commit-check.md
Full introductory article with frontmatter, enforcement model overview, example commands, default vs. cchk.toml behavior, a badge snippet, and follow-up resource links.
Configuring Commit Check post
docs/blog/posts/configuring-commit-check.md
Configuration guide covering CLI → env var → TOML resolution order, an annotated cchk.toml example, SchemaStore autocomplete tip, one-off CLI/env overrides, inherit_from org-wide sharing with security notes, and pre-push hook guidance.
AI-native Commit Check post
docs/blog/posts/ai-native-commit-check.md
Post documenting --format json structured output with preserved exit codes, --no-banner/--compact display options, and the commit_check.api in-process Python interface (validate_message, validate_branch, validate_all).
Site build configuration
mkdocs.yml
Enables "Blog" in top navigation and removes the blog/** exclusion rule, making blog posts visible in site build and navigation.

Estimated code review effort

🎯 2 (Simple) | ⏱️ ~10 minutes

Poem

🐇 Hippity-hop, three posts in a row,
From "what is this?" to configs that glow,
Then JSON and Python for AI's delight,
Each commit now checked with structured insight.
The rabbit approves — the docs look just right! ✨

🚥 Pre-merge checks | ✅ 5
✅ Passed checks (5 passed)
Check name Status Explanation
Description Check ✅ Passed Check skipped - CodeRabbit’s high-level summary is enabled.
Title check ✅ Passed The title accurately summarizes the main change: three new blog articles introducing commit-check are added to the documentation.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.

✏️ Tip: You can configure your own custom pre-merge checks in the settings.

✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch claude/three-articles-pr-0rjdvy

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

Comment @coderabbitai help to get the list of available commands and usage tips.

@shenxianpeng shenxianpeng added the blog New blogs label Jun 21, 2026
@shenxianpeng shenxianpeng merged commit ea86934 into main Jun 21, 2026
7 checks passed
@shenxianpeng shenxianpeng deleted the claude/three-articles-pr-0rjdvy branch June 21, 2026 20:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

blog New blogs

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants