Skip to content

Commit 955de79

Browse files
committed
ai(rules[AGENTS]): Clarify commit why rationale
why: Prevent commit messages from citing rule files instead of the engineering reason for a change. what: - Add guidance to keep the section pragmatic and contextual - Point agents to project history or ticket context when justification is unclear
1 parent a27924c commit 955de79

1 file changed

Lines changed: 2 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -362,6 +362,8 @@ what:
362362
- Focused on a single topic
363363
```
364364

365+
The `why:` must be the pragmatic, contextual reason behind the change — never cite AGENTS.md, CLAUDE.md, or other rule files as the justification. If you feel compelled to write "AGENTS.md says..." or "CLAUDE.md requires...", look at `git log -n 10 -p`, the PR description, and the ticket for the real engineering reason (e.g., "function had no doctest coverage" not "CLAUDE.md requires doctests").
366+
365367
Common commit types:
366368
- **feat**: New features or enhancements
367369
- **fix**: Bug fixes

0 commit comments

Comments
 (0)