Skip to content
This repository was archived by the owner on Sep 25, 2026. It is now read-only.

Commit 55c119b

Browse files
committed
style: reduce AI writing patterns in all three blog posts
1 parent b5ae234 commit 55c119b

3 files changed

Lines changed: 30 additions & 33 deletions

File tree

‎docs/blog/posts/ai-native-commit-check.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -15,8 +15,8 @@ authors:
1515
# AI-native: JSON output and a Python API
1616

1717
More and more commits are written — or at least drafted — by AI agents and
18-
automation. So Commit Check is built to be *consumed* by machines, not only
19-
read by humans squinting at ASCII art in a terminal. This post covers the two
18+
automation. So Commit Check is also built for machines — not just humans reading
19+
terminal output. This post covers the two
2020
features that make that possible: machine-readable JSON output and an
2121
import-friendly Python API.
2222

@@ -42,7 +42,7 @@ echo "feat: add streaming support" | commit-check -m --format json
4242
}
4343
```
4444

45-
The interesting case is failure. Each failing check carries the full `error`
45+
When a check fails, each result carries the full `error`
4646
and `suggest` fields an agent needs to **self-correct** — no scraping required:
4747

4848
```bash
@@ -64,8 +64,8 @@ echo "wip bad commit" | commit-check -m --format json
6464
}
6565
```
6666

67-
Feed that `suggest` string straight back to an LLM and it has everything it
68-
needs to rewrite the message and try again.
67+
Pass the `suggest` string back to an LLM, and it has what it needs to
68+
rewrite the message and retry.
6969

7070
## Quieter text, for humans
7171

@@ -87,10 +87,10 @@ echo "wip bad commit" | commit-check -m --compact
8787

8888
## The Python API — no subprocess needed
8989

90-
For tools and agents already running in Python, spawning a subprocess just to
91-
validate a string is wasteful. The `commit_check.api` module exposes a
92-
lightweight interface that returns plain dicts — easy to serialize, forward to
93-
an LLM, or chain into a larger workflow:
90+
For tools and agents running in Python, spawning a subprocess to validate
91+
a string adds unnecessary overhead. The `commit_check.api` module exposes
92+
functions that return plain dicts — easy to serialize, forward to an LLM,
93+
or chain into a larger workflow:
9494

9595
```python
9696
from commit_check.api import validate_message, validate_branch, validate_all
@@ -112,5 +112,5 @@ automated one — and gives that agent the precise feedback it needs to fix its
112112
own mistakes. One `cchk.toml`, enforced identically whether the author is a
113113
person, a CI job, or a model.
114114

115-
Read the full AI-native guide in the
115+
Read more in the
116116
[README](https://github.com/commit-check/commit-check#ai-native-usage).

‎docs/blog/posts/configuring-commit-check.md‎

Lines changed: 10 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,8 @@ authors:
1414
# From zero-config to org-wide policy
1515

1616
Commit Check works the moment you install it, but its real strength shows up
17-
when you start shaping the policy to fit your team. This post walks from the
18-
default behavior all the way to a configuration shared across an entire
19-
organization.
17+
when you start shaping the policy to fit your team. This post covers everything from the default behavior to organization-wide
18+
shared configuration.
2019

2120
<!-- more -->
2221

@@ -84,9 +83,9 @@ loosen a shared rule without forking the whole policy.
8483

8584
## Share one policy across many repos
8685

87-
The feature that turns Commit Check from a per-repo tool into an
88-
organizational standard is `inherit_from`. Point each repository at a base
89-
config and override only what differs:
86+
`inherit_from` is the feature that makes Commit Check work across an
87+
organization. Point each repository at a base config and override only what
88+
differs:
9089

9190
```toml
9291
# .github/cchk.toml — inherit the org base, then adjust locally
@@ -123,15 +122,14 @@ repos:
123122
stages: [pre-push]
124123
```
125124
126-
One note worth repeating from the docs: piping `git push` into `commit-check`
127-
is **not** a prevention mechanism. By then the push has already started, and
128-
standard `git push` output doesn't carry the ref metadata the check relies on.
129-
Use the `pre-push` hook instead.
125+
A note: piping `git push` into `commit-check` is **not** a prevention
126+
mechanism — by then the push has already started. Use the `pre-push` hook
127+
instead.
130128

131-
## The takeaway
129+
## Summary
132130

133131
Start with zero config, add a `cchk.toml` when you want stricter rules, and
134132
reach for `inherit_from` when you want one standard across every repository.
135-
Same engine, same file format, growing with your team.
133+
Same engine, same file format, scaling with your team.
136134

137135
Full reference: <https://commit-check.github.io/commit-check/configuration.html>

‎docs/blog/posts/introducing-commit-check.md‎

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,9 @@ authors:
1212

1313
# One policy file for your Git history
1414

15-
Every team eventually writes the same wiki page: "How we write commit
16-
messages." It lists a commit convention, a branch naming scheme, a rule about
17-
signing off, and a plea to keep author emails consistent. Then nobody reads it,
18-
and the rules quietly rot.
15+
Most teams have a wiki page titled something like "How we write commit
16+
messages." It covers commit conventions, branch naming, sign-offs, and
17+
author email consistency — and then nobody reads it.
1918

2019
**Commit Check** exists to turn that wiki page into something Git actually
2120
enforces.
@@ -33,9 +32,9 @@ commit that live around your code rather than inside it:
3332
- **Sign-off trailers** — `Signed-off-by` for DCO workflows
3433
- **Push safety** — catch accidental force-pushes before they rewrite history
3534

36-
The important word is *policy*. Instead of scattering these rules across a CI
37-
script here, a pre-commit hook there, and a half-remembered convention
38-
everywhere, you write them **once** in a versioned `cchk.toml`.
35+
That word — *policy* — matters. Instead of scattering rules across a CI
36+
script, a pre-commit hook, and a stale convention doc, you write them
37+
**once** in a versioned `cchk.toml`.
3938

4039
## Write it once, enforce it everywhere
4140

@@ -54,7 +53,7 @@ The same `cchk.toml` then drives:
5453

5554
Because the policy is committed alongside your code, it is reviewed, diffed, and
5655
versioned like everything else. When the rules change, the change shows up in a
57-
pull request — not in a Slack message that scrolls away.
56+
pull request.
5857

5958
## Zero configuration to start
6059

@@ -68,9 +67,9 @@ convention. That is enough to get value on day one.
6867
echo "feat: add streaming support" | commit-check -m
6968
```
7069

71-
When you are ready to tighten things up — a maximum subject length, required
72-
sign-off, an allow-list of commit types — you add a `cchk.toml` and grow into
73-
it. We will cover that in the next post.
70+
When you need stricter rules — a maximum subject length, required sign-off,
71+
or an allow-list of commit types — add a `cchk.toml`. The next post walks
72+
through the details.
7473

7574
## Add the badge
7675

0 commit comments

Comments
 (0)