Visitar URL original
docs: describe Commit Check as commit policy as code for teams and AI… · commit-check/commit-check@1be275f · GitHub
Skip to content

Commit 1be275f

Browse files
shenxianpengshenxianpeng
authored
docs: describe Commit Check as commit policy as code for teams and AI agents (#604)
The README intro and the PyPI summary now open with the line the org profile, the Action, the MCP server and commit-check.com already lead with. The PyPI keywords gain "policy as code" and "ai agents". PyPI shows the new summary and README from the next release. Co-authored-by: Xianpeng Shen <3353385+shenxianpeng@users.noreply.github.com>
1 parent 60a1294 commit 1be275f

2 files changed

Lines changed: 7 additions & 6 deletions

File tree

‎README.md‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,10 +21,11 @@
2121

2222
</div>
2323

24-
**Commit Check** validates commit messages, branch names, authors, sign-offs,
25-
tags, committed files and AI attribution against one `cchk.toml` — in your
26-
commit hook, in CI, on every pull request and inside your AI agent. When the
27-
fix is obvious, it hands you the line.
24+
**Commit Check** is commit policy as code for teams and AI agents. It validates
25+
commit messages, branch names, authors, sign-offs, tags, committed files and AI
26+
attribution against one `cchk.toml` — in your commit hook, in CI, on every
27+
pull request and inside your AI agent. When the fix is obvious, it hands you
28+
the line.
2829

2930
![commit-check demo](https://github.com/commit-check/commit-check/raw/main/assets/demo.gif)
3031

‎pyproject.toml‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,9 @@ build-backend = "setuptools.build_meta"
44

55
[project]
66
name = "commit-check"
7-
description = "Check commit message formatting, branch naming, commit author, email, and more."
7+
description = "Commit policy as code for teams and AI agents: check commit messages, branch names, authors, tags, files and AI attribution."
88
readme = "README.md"
9-
keywords = ["commit conventions", "conventional commits", "conventional branch", "branch naming", "commit-check", "message", "lint message", "devops"]
9+
keywords = ["commit conventions", "conventional commits", "conventional branch", "branch naming", "commit-check", "message", "lint message", "devops", "policy as code", "ai agents"]
1010
license = "MIT"
1111
authors = [
1212
{ name = "Xianpeng Shen", email = "xianpeng.shen@gmail.com" },

0 commit comments

Comments
 (0)