Skip to content

docs: put the GitHub App first on the org profile #70

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
shenxianpeng merged 1 commit into from
Oct 20, 2026
Merged

docs: put the GitHub App first on the org profile #70

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 11 additions & 4 deletions profile/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
│ │ │ │
└─────────────────┴────────┬────────┴─────────────────┘
▼
Expand All @@ -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
Expand All @@ -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

Expand Down
Loading