diff --git a/profile/README.md b/profile/README.md index 4cc2a8d..1ca9811 100644 --- a/profile/README.md +++ b/profile/README.md @@ -41,8 +41,8 @@ comment, or an MCP tool call. │ ┌─────────────────┼─────────────────┬─────────────────┐ ▼ ▼ ▼ ▼ - your machine pre-commit GitHub CI AI agents - (commit-check) hook Action (MCP) + your machine pre-commit GitHub App AI agents + (commit-check) hook or Action (MCP) │ │ │ │ └─────────────────┴────────┬────────┴─────────────────┘ ▼ @@ -58,11 +58,18 @@ accepted?"* gets the answer your maintainers actually configured. Nothing to configure to begin with: the defaults enforce Conventional Commits, Conventional Branch, and sane subject lengths. +On GitHub, the quickest start is the **[Commit Check App](https://github.com/apps/commit-check)**: +install it on your organization or account, and every push and pull request +gets a check run, with no workflow file. It is free for public repositories and +personal accounts. + +To run the checks yourself instead: + ```yaml # .pre-commit-config.yaml — feedback while the message is still being written repos: - repo: https://github.com/commit-check/commit-check - rev: v2.19.1 + rev: v2.19.2 hooks: - id: check-message - id: check-branch @@ -84,10 +91,10 @@ Every rule and option is at **[commit-check.com](https://commit-check.com)**. | Project | What it is | Use it for | | --- | --- | --- | +| [**Commit Check App**](https://github.com/apps/commit-check) | GitHub App | Org-wide checks with no workflow file, on every push and pull request | | [**commit-check**](https://github.com/commit-check/commit-check) | Python CLI & pre-commit hook | Local checks, CI pipelines, scripting | | [**commit-check-action**](https://github.com/commit-check/commit-check-action) | GitHub Action | PR & push validation, job summaries, PR comments | | [**commit-check-mcp**](https://github.com/commit-check/commit-check-mcp) | Model Context Protocol server | Letting AI agents validate against your rules | -| [**Commit Check App**](https://github.com/apps/commit-check) | GitHub App | Org-wide checks with no workflow file, on every push and pull request | ## What it does not do