Skip to content

Commit ee4a39a

Browse files
committed
docs: expand commit message guidelines in AGENTS.md
1 parent 58590e8 commit ee4a39a

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

AGENTS.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,13 +40,15 @@ PSR-12 for PHP. Mago for lint/format (`composer lint`, `composer format`). Prett
4040
## Commit Message Guidelines
4141

4242
- Commit messages must follow Conventional Commits
43+
- Write messages so they make sense for commit-by-commit development: each commit describes the actual state change from the previous shipped state. Do not mention intermediate or throwaway steps (e.g. classes created and removed in the same session). Describe what the commit delivers, not the path taken to get there
4344
- Subject format: `<type>(<scope>): <summary>`; use `<type>: <summary>` when scope is omitted
4445
- Allowed `type` values: `feat`, `fix`, `refactor`, `perf`, `docs`, `test`, `build`, `ci`, `chore`, `revert`
4546
- `scope` is optional but recommended when it narrows the area (e.g. `StringValidator`, `FieldValidator`, `AssociativeValidator`)
46-
- Write summary lines in imperative mood, keep them concise (around 72 characters when practical), and omit trailing periods
47+
- Write summary lines in imperative mood, keep them concise (around 72 characters recommended, not strict), and omit trailing periods
4748
- Keep each commit focused on one concern; include related tests or validation updates in the same commit when applicable
4849
- Prefer bullet lists in commit bodies for concrete changes, with one logical change per bullet
4950
- Commit body bullets should start with a capitalized imperative verb and omit trailing periods
51+
- Never artificially break lines anywhere in a commit message; tools wrap naturally
5052
- Avoid unnecessary noise in commit bodies; include only explicit, intentional, non-obvious updates
5153
- Do not call out secondary artifact changes (for example lockfile refreshes) unless they carry non-obvious impact
5254
- Add a short prose paragraph only when extra context is needed (rationale, tradeoffs, migration notes, risks, or non-obvious impact)

0 commit comments

Comments
 (0)