Skip to content

docs: describe the server as commit policy as code for AI agents - #41

Merged
shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-pofwgp
Oct 8, 2026
Merged

shenxianpeng merged 1 commit into
mainfrom
claude/project-thread-pofwgp

Conversation

@shenxianpeng

@shenxianpeng shenxianpeng commented Oct 7, 2026 •

Copy link
Copy Markdown
Member

Before:

  • The MCP Registry listing (server.json) read "Validate commit messages, branch names, author info, push safety, and repo state."
  • The PyPI summary read "MCP server exposing commit-check validation tools".

After:

  • The registry listing reads "Commit policy as code for AI agents: check commit messages, branch names and authors before a push".
  • The PyPI summary reads "MCP server for Commit Check: commit policy as code for teams and AI agents".
  • The README's opening sentence carries the same line.

How: this changes three lines. The registry caps descriptions at 100 characters, and the new one is 98. Both the registry and PyPI pick the change up at the next publish. Companion PRs put the same line at the front of the org profile, the Action and commit-check.com.

🤖 Generated with Claude Code

https://claude.ai/code/session_013rE6bouKaJvsRyKA4tjqCb


Generated by Claude Code

Summary by CodeRabbit

  • Documentation
    • Updated the project descriptions to explain how AI agents can check commit messages, branch names, and authors against team policies before committing or pushing.

server.json's description is what the MCP Registry lists and
pyproject's is the PyPI summary. Both, and the README's opening
paragraph, now lead with the line the project is putting at the front
of its public copy. The registry caps descriptions at 100 characters
(this one is 98); it and PyPI pick the change up at the next publish.
@coderabbitai

coderabbitai Bot commented Oct 7, 2026 •

Copy link
Copy Markdown

Review in Change Stack →

No actionable comments were generated in the recent review. 🎉

ℹ️ Recent review info
⚙️ Run configuration
  • Configuration used: defaults
  • Review profile: CHILL
  • Plan: Advanced
  • Run ID: 8ddf7afc-bd99-4db2-9902-c4d537d3c143
📥 Commits

Reviewing files that changed from the base of the PR and between 2f234c6 and bffcf52.

📒 Files selected for processing (3)
  • README.md
  • pyproject.toml
  • server.json

Included review availability: This review used your included allowance. Your plan provides up to 1 included review per hour; 0 remain after this review.


📝 Walkthrough

Walkthrough

The README and package and server metadata now describe Commit Check as policy as code for teams and AI agents. The README also states that agents validate commit messages, branch names, and authors against CI rules before committing or pushing.

Changes

Commit policy descriptions

Layer / File(s) Summary
Update product descriptions
pyproject.toml, server.json, README.md
The package and server metadata now describe Commit Check as commit policy as code for AI agents. The README describes the policy checks and corrections provided to agents.

Priority: ⬇️ Low

Estimated code review effort: 1 (Trivial) | ~5 minutes

Change: Other

Merge Risk: ⚪ Minimal · up to bffcf

The updated descriptions match the available checks and documented agent workflow. No material merge risk remains.

🚥 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 clearly and concisely describes the main documentation change: presenting the server as commit policy as code for AI agents.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check. Docstring coverage is scoped to functions touched by this diff. Analyzed 0 functions across 0…
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.
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Commit to this branch
  • Create a new PR
  • Autopilot · 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

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

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 7, 2026
@codecov-commenter

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 100.00%. Comparing base (2f234c6) to head (bffcf52).

Additional details and impacted files
@@            Coverage Diff            @@
##              main       #41   +/-   ##
=========================================
  Coverage   100.00%   100.00%           
=========================================
  Files            2         2           
  Lines          279       279           
=========================================
  Hits           279       279           

☔ 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.

@shenxianpeng
shenxianpeng merged commit e89f71b into main Oct 8, 2026
9 checks passed
@shenxianpeng
shenxianpeng deleted the claude/project-thread-pofwgp branch October 8, 2026 04:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants