Skip to content

Commit 522a2a8

Browse files
authored
docs: add commit and pull request guidance to AGENTS.md (#13)
Agent-written PRs ran about 20 times longer than hand-written ones. Sets a length budget, the pronoun-free rule, and what to leave out.
1 parent 97e0d11 commit 522a2a8

1 file changed

Lines changed: 19 additions & 0 deletions

File tree

‎AGENTS.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,25 @@ Reach for existing components & styles first; add new ones only when the design
8484
genuinely needs them. Capitalize visually with `text-transform: uppercase` rather than
8585
uppercasing the content in source.
8686

87+
## Commits and pull requests
88+
89+
Commit and PR bodies are a short note, not a report. Follow the repo's PR template: fill
90+
each section in a line, or remove it when it's optional and empty.
91+
92+
- Pronoun-free, as in all studio copy: no "I", "we", or "our" in PR titles, descriptions,
93+
PR comments, or commit bodies.
94+
- PR descriptions: 1 to 3 sentences of prose by default, ~100 words at most. Lead with a
95+
verb; never open with "This PR".
96+
- Commit bodies: 1 to 2 sentences, or none for a small change.
97+
- Cover what changed, the why when the title doesn't already say it, and anything someone
98+
must act on (a breaking change, a manual step).
99+
- Leave out environment or sandbox notes, after-merge process, file lists the diff already
100+
shows, speculation about causes, side findings (open an issue instead), unfilled
101+
template comments, and an empty `Closes #`.
102+
- Test plan: one line on what was actually checked.
103+
- Review replies: one sentence plus the commit SHA.
104+
- No headers beyond the template's, no bold-label bullets, no em dashes.
105+
87106
## Attribution
88107

89108
Never add AI attribution to a commit or a PR in any studio repo: no `Co-Authored-By`

0 commit comments

Comments
 (0)