docs: describe commit-msg summary and bullet requirements

Contributor guides now match what the hook enforces so failures are obvious
before push when core.hooksPath points at .githooks.

- Refresh commit.prompt.md hook bullets and the canonical message checklist
- Update AGENTS.md workflow paragraph for commit-msg structure plus line cap
This commit is contained in:
Jukka Aho
2026-05-11 02:46:14 +03:00
parent e7862ed538
commit 2bfc78a37c
2 changed files with 31 additions and 16 deletions
+28 -14
View File
@@ -46,9 +46,10 @@ After `git config core.hooksPath .githooks`:
supports the common “impl + test” or “snippet + verifier” pair without supports the common “impl + test” or “snippet + verifier” pair without
allowing large batches. Split bigger changes across commits or adjust the allowing large batches. Split bigger changes across commits or adjust the
hook deliberately. hook deliberately.
- **commit-msg:** rejects the commit if **any** message line is longer than - **commit-msg:** enforces the **subject → blank → summary → blank → bullets**
**80 characters** (including the subject). Wrap prose and bullets; merge layout, **≥1** `- ...` detail line, **no** blanks inside the bullet block, and
commits skip this check while `.git/MERGE_HEAD` is present. **≤80** characters per line. Merge commits skip checks while `.git/MERGE_HEAD`
is present.
## Read the full staged diff ## Read the full staged diff
@@ -95,19 +96,29 @@ EOF
**3. Summary** — one short paragraph, **one to three sentences**: what changed and why, for this commit only. **3. Summary** — one short paragraph, **one to three sentences**: what changed and why, for this commit only.
**4. Body detail (scale with the diff)** — after the summary: **4. Blank line** (separator before the bullet list).
- **Small / localized change:** optional bullets only when they add real value; often the summary is enough. **5. Body detail — `-` bullets (required when `.githooks/commit-msg` is active):**
- **Large file, large diff, or several concerns in one commit:** expand with **substantive bullets**. Prefer **grouped sections** (short headings or bullet groups) that mirror the patch: major types/functions added, behavior changes, wiring/exports, migrations, risks, or follow-ups. A few vague bullets are not sufficient when the diff is hundreds of lines or touches multiple subsystems—the message should let a reviewer reconstruct *why* the patch looks the way it does without re-reading every hunk.
Use `-` bullet lists; omit sections that do not apply. After the separator blank line, write **at least one** `- ...` line. Scale depth
to the diff: a tiny change can use a single substantive bullet; large or
multi-file patches need **grouped, substantive bullets** (major types or
functions, behavior, wiring, migrations, caveats) so a reviewer can reconstruct
the story without re-reading every hunk.
### Line length (enforced when hooks are enabled) ### Hook-enforced shape (with `core.hooksPath` → `.githooks`)
Keep **every** line at **80 characters or fewer**, including the subject and The **commit-msg** hook (except during merges while `.git/MERGE_HEAD` exists)
each bullet. This keeps `git log` readable in terminals and mail archives. If requires, in order:
the hook is enabled, overlong lines cause the commit to fail—rewrap before
retrying. 1. non-empty subject line;
2. blank line;
3. one or more summary lines (none may start like a `- ` bullet);
4. blank line;
5. one or more lines each starting with `- ` (details).
Every line must be **80 characters or fewer**. There must be **no** blank lines
inside the bullet block. Rewrap before committing.
### Example (single file) ### Example (single file)
@@ -147,7 +158,7 @@ When proposing:
# ❌ WRONG # ❌ WRONG
git commit -m "Update documentation" git commit -m "Update documentation"
# ✅ RIGHT — subject + summary (+ bullets if needed), from the real diff # ✅ RIGHT — subject, blank, summary, blank, "- ..." bullets (from the diff)
``` ```
### Bundling unrelated files ### Bundling unrelated files
@@ -176,7 +187,10 @@ Never use `git diff --staged | head` (etc.). Read the full diff.
- [ ] Did I read the **full** `git diff --staged`? - [ ] Did I read the **full** `git diff --staged`?
- [ ] Subject line: Conventional Commits, specific, matches diff? - [ ] Subject line: Conventional Commits, specific, matches diff?
- [ ] Is **every** message line (subject, summary, bullets) **≤ 80 characters**? - [ ] Is **every** message line (subject, summary, bullets) **≤ 80 characters**?
- [ ] Body: blank line, then **13 sentence** summary, then **bullets scaled to diff size** (rich, grouped bullets for large / multi-concern commits)? - [ ] Shape: subject, **blank**, summary paragraph, **blank**, then **≥1** `-`
bullet (required when the commit-msg hook is enabled)?
- [ ] Bullets **scaled to the diff** (one tight bullet is fine for a one-liner
patch; large patches need rich, grouped bullets)?
- [ ] Did I **propose** the commit and wait for **approval** before `git commit`? - [ ] Did I **propose** the commit and wait for **approval** before `git commit`?
## Why this matters ## Why this matters
+3 -2
View File
@@ -207,8 +207,9 @@ These are non-negotiable. Tests and code analysis enforce them.
Contributor-facing workflow text lives in `.github/prompts/commit.prompt.md` Contributor-facing workflow text lives in `.github/prompts/commit.prompt.md`
and `.github/copilot-instructions.md`. Optional `.githooks/` hooks (enable with and `.github/copilot-instructions.md`. Optional `.githooks/` hooks (enable with
`git config core.hooksPath .githooks`): **pre-commit** caps staged paths at `git config core.hooksPath .githooks`): **pre-commit** caps staged paths at
two per commit; **commit-msg** rejects any log line longer than **80 two per commit; **commit-msg** enforces subject, blank, summary paragraph,
characters** (merge commits skip that check while `.git/MERGE_HEAD` exists). blank, then `-` bullets (with line length **≤80**); merge commits skip while
`.git/MERGE_HEAD` exists.
Editor-local Cursor rules under `.cursor/` are not part of the git tree. Editor-local Cursor rules under `.cursor/` are not part of the git tree.
- Commits: prefer **small** steps (default one file per commit). Combine - Commits: prefer **small** steps (default one file per commit). Combine