Skip to content

Commit 591ec3e

Browse files
committed
docs: describe the Action as commit policy as code for teams and AI agents
action.yml's description is the summary the Marketplace shows. It now leads with the line the project is putting at the front of its public copy, as does the README's opening paragraph. The Marketplace reads action.yml from a release, so the new summary reaches it with the next release.
1 parent dd7ef20 commit 591ec3e

2 files changed

Lines changed: 6 additions & 5 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-
The GitHub Action for [Commit Check](https://github.com/commit-check/commit-check).
25-
It checks every commit of a pull request — message, branch, author, and
26-
optionally the PR title — against your `cchk.toml`, and reports the result in
27-
the job summary, as annotations on the diff and, if you want, as a PR comment.
24+
The GitHub Action for [Commit Check](https://github.com/commit-check/commit-check),
25+
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.
2829

2930
## Usage
3031

‎action.yml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
name: Commit Check Action
2-
description: Check commit message formatting, branch naming, committer name, email, and more
2+
description: "Commit policy as code for teams and AI agents: check every commit of a pull request against your cchk.toml"
33
author: shenxianpeng
44
branding:
55
icon: "git-commit"

0 commit comments

Comments
 (0)