Skip to content

Commit 07688db

Browse files
authored
feat(site): put prices on the page, and fix three dead links (#38)
Site half of the Marketplace listing work. App half: commit-check/commit-check-app#36. > Two commits. The first put a four-plan ladder on the page; the second cuts it to three. The diff against `main` is the thing to review. ## The dead links `github.com/marketplace/commit-check` **returns 404** — the listing is not published. Three places linked to it: - `docs/index.md` — the Pricing section's "See the plan on the Marketplace" - `docs/guides/github-app.md` — the opening sentence, and the primary Install button All three now point at `github.com/apps/commit-check`, which resolves today. They move back to the Marketplace URL as the last step of publishing the listing. ## Pricing | Plan | Price | Covers | |---|---|---| | Open Source | Free | Public repositories, on any account | | Personal | Free | Private repositories on a personal account | | Team | $19 / month | Private repositories in an organization, at any size | **Prices are on the page.** autofix.ci keeps every number on the Marketplace and links out. Copying that would be wrong here: this section already argues that GitHub charges $21 a seat and about $340 a month for a twenty-person team, and that argument does not land unless the number it is being compared against is sitting next to it. The closing line now reads "Nineteen dollars is what the same twenty people cost here — and the same twenty thousand", which is the seat-independence doing work. **No seat tiers.** The App cannot enforce a seat count — it holds no organization permissions, and GitHub does not check seats on a flat-rate plan. Publishing "up to 25 users" would be an honour system with a 5× cliff at 25 and nothing above 200. **Personal stays free.** It competes with our own GitHub Action, which does the same job on a private personal repository inside GitHub's free Actions allowance. `guides/github-app.md` had promised "and stay free"; that sentence is intact. The MIT tools get their own lead sentence instead of being folded into a card called "Free", since "Free" is now two plan names that each mean something narrower. ## New: Terms of Service `/terms` was a 404 and the Marketplace listing wants one as a resource. Covers what the service does, billing (GitHub's, not ours), availability, liability, and the exit — the Action reads the same `cchk.toml`, so nothing you write is locked to the hosted App. **This is a starting draft and wants a human read before the listing goes in for review.** I am not a lawyer. ## New FAQ entry "Who is behind this?" — the eight existing entries never say who runs the hosted service. autofix.ci names its maintainer in its FAQ, and on a paid App that is a real trust signal. ## Layout Three cards fit the shared `.cc-cards` grid, so the `minmax` override the four-card version needed is reverted. Measured, not assumed: | Viewport | Layout | |---|---| | 1024px and up | one row of three | | 700–820px | 2 + 1 | | 600px and below | stacked | ## Testing `mkdocs build --strict` clean (0 warnings, `SOCIAL_CARDS=false` locally since `cairosvg` is not in my env). Rendered and eyeballed the Pricing section, the App guide's Plans table and the new Terms page. `tests/docs_sync_test.py` could not run locally — it imports `commit_check.rules_catalog`, not installed in this interpreter. Untouched by this PR; CI passes it. Also caught: `commit-check/commit-check-app` is private, so links into it 404 for the public. The Terms page's security and issue-tracker links point at `commit-check/commit-check` instead.
1 parent 5f1a6a0 commit 07688db

4 files changed

Lines changed: 153 additions & 17 deletions

File tree

‎docs/guides/github-app.md‎

Lines changed: 25 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
# GitHub App
22

3-
The hosted [Commit Check App](https://github.com/marketplace/commit-check)
3+
The hosted [Commit Check App](https://github.com/apps/commit-check)
44
runs the same rule engine as the CLI, against the same config file, with no
55
workflow file and no CI minutes. Install it once, push, and every commit gets
66
a **Commit Check** result that says what failed, the value that failed, and
77
how to fix it. Not every rule applies where the App runs; the
88
[list](#which-rules) is below.
99

10-
[Install from the GitHub Marketplace](https://github.com/marketplace/commit-check){ .md-button .md-button--primary }
10+
[Install the App](https://github.com/apps/commit-check){ .md-button .md-button--primary }
1111

1212
Choosing between the App and the [GitHub Action](github-actions.md): see
1313
[Where to run it](integrations.md#app-or-action). Both read the same config and
@@ -178,11 +178,29 @@ without a wall of red.
178178

179179
## Plans
180180

181-
Public repositories and everything on personal accounts are free, and stay
182-
free. Today that is every repository: private repositories in organizations
183-
are checked at no charge while the App is new, and a paid **Team** plan for
184-
them is planned. When it arrives, a repository it applies to gets a neutral
185-
check saying so — nothing is blocked — and this page will say so first.
181+
Public repositories are free on any account, and everything on a personal
182+
account is free, and both stay free. Only an organization's private
183+
repositories are paid:
184+
185+
| Plan | Price | Covers |
186+
|---|---|---|
187+
| Open Source | Free | Public repositories, on any account |
188+
| Personal | Free | Private repositories on a personal account |
189+
| Team | $19 / month | Private repositories in an organization, 14-day free trial |
190+
191+
The Team plan is not tiered by seat count. Twenty of you and twenty thousand of
192+
you pay the same, so growing the team never changes the bill.
193+
194+
Today none of this is enforced: every repository is checked at no charge while
195+
the App is new. When the plan goes live, a private organization repository
196+
without it gets a neutral check saying so — nothing is blocked, nothing is
197+
rejected — and this page will say so before it happens.
198+
199+
The [CLI](../getting-started.md), the [pre-commit hook](pre-commit.md),
200+
the [GitHub Action](github-actions.md) and the [MCP server](mcp.md) are MIT
201+
licensed and always free. If you would rather not pay for the App on an
202+
organization's private repositories, the Action reads the same config and
203+
reports the same rule IDs — it just costs you CI minutes instead.
186204

187205
## Privacy
188206

‎docs/index.md‎

Lines changed: 27 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -275,29 +275,35 @@ One policy engine, five places to enforce it. Every one of them reads the same
275275

276276
## Pricing
277277

278+
The CLI, the pre-commit hook, the GitHub Action and the MCP server are MIT
279+
licensed — no account, no limits, nothing to buy. The plans below are for the
280+
hosted GitHub App, the one surface we run for you.
281+
278282
<div class="cc-pricing" markdown>
279283

280-
- __Free__
284+
- __Open Source__ · Free
281285

282286
---
283287

284-
The CLI, the pre-commit hook, the GitHub Action and the MCP server. MIT
285-
licensed, no account, no limits.
288+
Public repositories, on any account.
289+
290+
- __Personal__ · Free
291+
292+
---
286293

287-
The hosted GitHub App is free too on public repositories and personal
288-
accounts.
294+
Private repositories on a personal account.
289295

290-
- __Team__
296+
- __Team__ · $19 / month
291297

292298
---
293299

294-
The hosted GitHub App on an organization's private repositories, with a
300+
Private repositories in an organization, however many of you there are.
295301
14-day free trial.
296302

297-
[:octicons-arrow-right-24: See the plan on the Marketplace](https://github.com/marketplace/commit-check)
298-
299303
</div>
300304

305+
[:octicons-arrow-right-24: Install the App](https://github.com/apps/commit-check)
306+
301307
Nothing is blocked while you try it. Without a config file the App reports its
302308
findings but leaves the check run neutral, and it never rejects a push — the
303309
only way Commit Check blocks a merge is if you make it a required check
@@ -307,7 +313,9 @@ GitHub can enforce some of the same policies natively, but the commit-metadata
307313
rules sit behind its Enterprise plan. For a twenty-person team that is the
308314
difference between $4 and $21 a seat — about $340 a month for a regular
309315
expression, which reports a bare mismatch where Commit Check reports a rule ID,
310-
a suggestion and a link. [The arithmetic and the honest caveats](compare/github-rules.md).
316+
a suggestion and a link. Nineteen dollars is what the same twenty people cost
317+
here — and the same twenty thousand.
318+
[The arithmetic and the honest caveats](compare/github-rules.md).
311319

312320
## Questions
313321

@@ -357,6 +365,15 @@ a suggestion and a link. [The arithmetic and the honest caveats](compare/github-
357365
GitHub Action verifies the attestation with `gh attestation verify` before
358366
it installs anything, and fails the step if verification does not pass.
359367

368+
??? question "Who is behind this?"
369+
370+
Commit Check is written and maintained by
371+
[Xianpeng Shen](https://github.com/shenxianpeng), who also runs the hosted
372+
App. The engine, the Action, the App and the MCP server are open source
373+
under the [commit-check](https://github.com/commit-check) organization —
374+
if the hosted App ever stops, the [GitHub Action](guides/github-actions.md)
375+
reads the same config and reports the same rule IDs.
376+
360377
<div class="cc-community" markdown>
361378

362379
## Questions, bugs, contributions

‎docs/terms.md‎

Lines changed: 100 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,100 @@
1+
# Terms of Service
2+
3+
These terms cover the **Commit Check GitHub App** — the hosted service we run,
4+
which you install onto your GitHub account. The command-line tool, the
5+
pre-commit hooks, the GitHub Action and the MCP server are not covered here:
6+
they run inside your own environment and are governed by the [MIT
7+
licence](https://github.com/commit-check/commit-check/blob/main/LICENSE) of the
8+
repository you got them from.
9+
10+
Installing the App means you accept these terms.
11+
12+
## What the service does
13+
14+
The App reads the commits of a push or pull request and the repository's
15+
configuration file, evaluates them against the rules that file turns on, and
16+
posts the result as a GitHub check run. That is all it does. It never writes to
17+
your repository, never rejects a push, and never blocks a merge on its own — a
18+
failing check only blocks a merge if you make it a
19+
[required status check](https://docs.github.com/en/repositories/configuring-branches-and-merges-in-your-repository/managing-protected-branches/about-protected-branches#require-status-checks-before-merging)
20+
yourself.
21+
22+
What it reads and what it stores is set out on the [privacy page](privacy.md).
23+
24+
## Your side
25+
26+
You are responsible for the repositories you install the App on, for the rules
27+
you turn on, and for having the right to install it on an organization's
28+
repositories. Do not attempt to disrupt the service — for instance by sending
29+
traffic designed to exhaust it, or by probing it for vulnerabilities without
30+
telling us first. If you find a security problem, please
31+
[report it](https://github.com/commit-check/commit-check/security/policy) rather
32+
than exploiting it.
33+
34+
## Plans, billing and trials
35+
36+
**Nothing is charged today.** The Marketplace listing is not published yet, so
37+
there is no plan to buy and every repository is checked at no charge. This
38+
section describes what will apply once it is; the
39+
[pricing section](index.md#pricing) and the
40+
[App guide](guides/github-app.md#plans) say the same, and will say so before
41+
anything changes.
42+
43+
Public repositories are free on any account, and so is everything on a personal
44+
account. An organization's private repositories will be covered by the Team
45+
plan, at the price shown in the pricing section.
46+
47+
Billing, trials, renewals, cancellations and refunds will be handled by GitHub
48+
under the [GitHub Marketplace Terms of
49+
Service](https://docs.github.com/en/site-policy/github-terms/github-marketplace-terms-of-service),
50+
not by us — we never see your payment details. The Team plan comes with a
51+
14-day free trial; cancelling is done from your GitHub account's billing
52+
settings and takes effect at the end of the current period.
53+
54+
If the price changes, the change applies to your account from the next
55+
renewal, and GitHub notifies you.
56+
57+
## Availability
58+
59+
The App is offered as is. We aim to keep it running and to fix what breaks, but
60+
we do not promise a level of uptime, and there is no support commitment beyond
61+
the [issue tracker](https://github.com/commit-check/commit-check/issues).
62+
We may change how the service works, or stop running it, with notice on this
63+
site and on the Marketplace listing.
64+
65+
If the hosted App stops being available to you, the
66+
[GitHub Action](guides/github-actions.md) reads the same configuration file and
67+
reports the same rule IDs. Nothing you write in `cchk.toml` is locked to the
68+
hosted service.
69+
70+
## Liability
71+
72+
To the extent the law allows, the App is provided without warranty of any kind,
73+
and we are not liable for indirect or consequential loss arising from using it
74+
— including anything that follows from a check run that passed when you think
75+
it should have failed, or failed when you think it should have passed. Commit
76+
Check validates commit metadata; it is not a review, a test suite or a security
77+
control, and it is not a substitute for any of them.
78+
79+
Where liability cannot be excluded, it is limited to what you paid for the
80+
service in the twelve months before the claim.
81+
82+
## Ending it
83+
84+
You can end these terms at any time by uninstalling the App from your account.
85+
We may suspend or end an installation that breaches these terms, or that is
86+
being used to disrupt the service.
87+
88+
## Changes to these terms
89+
90+
Changes are published on this page, and the date below changes with them.
91+
Continuing to use the App after a change means you accept it. If a change
92+
matters materially to paying accounts, we will also note it on the Marketplace
93+
listing.
94+
95+
## Contact
96+
97+
[Open an issue](https://github.com/commit-check/commit-check/issues) for
98+
anything about these terms or the service.
99+
100+
_Last updated: 2026-09-07._

‎mkdocs.yml‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -175,6 +175,7 @@ nav:
175175
- Configuration: configuration.md
176176
- Changelog: changelog.md
177177
- Privacy: privacy.md
178+
- Terms of Service: terms.md
178179
- Compare:
179180
- GitHub's built-in rules: compare/github-rules.md
180181
- Other tools: compare/tools.md

0 commit comments

Comments
 (0)