Skip to content

Commit ed3ed0f

Browse files
committed
docs(agents): require better commit messages
Add explicit commit-message guidance to AGENTS.md so future commits in this repo have a higher baseline than "ship it and pray". Document a preferred conventional-commit subject, require a real body for non-trivial changes, and spell out the expected structure: subject line, blank line, then a body that explains why the change was needed, what changed, and any relevant validation or constraints. Also call out anti-patterns such as vague subjects and unwanted attribution trailers so commit history stays useful in git log instead of turning into archaeological rubble.
1 parent 9a1a63e commit ed3ed0f

1 file changed

Lines changed: 14 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,20 @@ All dependency versions live in the root `Cargo.toml` `[workspace.dependencies]`
8888
- Do not amend commits unless explicitly asked.
8989
- Only create commits when the user asks.
9090

91+
## Commit Messages
92+
93+
- Prefer conventional commits when they fit: `feat|fix|docs|refactor|test|chore(scope): summary`.
94+
- Use a real commit body for any non-trivial change. One-line commits are for genuinely tiny edits only.
95+
- Structure commit messages like this:
96+
1. Subject line: concise, imperative, and specific about the user-visible or architectural change.
97+
2. Blank line.
98+
3. Body: short paragraphs or bullets explaining why the change was needed, what changed, and any important constraints, follow-ups, or migrations.
99+
- The body should capture the reasoning that will matter in `git log` six months later, not just restate the diff.
100+
- Call out behavior changes, fallback paths, performance work, or bug triggers explicitly when they motivated the change.
101+
- If validation was important, mention the key checks in the body instead of making reviewers guess.
102+
- Avoid useless subjects like `fix stuff`, `updates`, `wip`, or `misc cleanup`.
103+
- Do not add `Co-Authored-By` or AI attribution trailers unless the user explicitly asks for them.
104+
91105
## PR Review Comments
92106

93107
When working in a worktree linked to a pull request, check `.arbor/pr-comments.md` for

0 commit comments

Comments
 (0)