Commit d93ac04
authored
pr-checklist: add PR description guidance for agents (#5105)
## Changes
Add a `## PR description` section to
`.agent/skills/pr-checklist/SKILL.md` telling agents to:
- Follow `.github/PULL_REQUEST_TEMPLATE.md` exactly — same headings (`##
Changes`, `## Why`, `## Tests`), same order, no invented sections like
`## Summary` / `## Test plan`, no leftover HTML comment placeholders.
- Read the template before passing `--body` to `gh pr create`.
- Disclose agent involvement on the last line of the body (e.g. `_This
PR was written by Claude Code._`), with the level of involvement
honestly reflected.
## Why
Agents drafting PRs in this repo have been freelancing the structure —
emitting `## Summary` / `## Test plan` headings (the generic Claude Code
defaults) instead of the repo's `## Changes` / `## Why` / `## Tests`
template, leaving HTML comment placeholders in, or omitting the
agent-authorship disclosure. Encoding this in the pre-PR checklist skill
means the agent picks up the rule the same way it picks up the lint/test
commands, instead of relying on reviewers to catch it after the fact.
## Tests
Docs-only change to a skill markdown file; no automated tests apply.
_This PR was written by Claude Code._1 parent 987c2d9 commit d93ac04
1 file changed
Lines changed: 8 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
42 | 42 | | |
43 | 43 | | |
44 | 44 | | |
| 45 | + | |
| 46 | + | |
| 47 | + | |
| 48 | + | |
| 49 | + | |
| 50 | + | |
| 51 | + | |
| 52 | + | |
45 | 53 | | |
46 | 54 | | |
47 | 55 | | |
| |||
0 commit comments