Skip to content

Commit d93ac04

Browse files
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

File tree

.agent/skills/pr-checklist/SKILL.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,14 @@ After the commands above pass, scrub the diff before pushing. The quick version:
4242
- **TODOs without a ticket**: either add a ticket reference (e.g. `// TODO(DECO-1234): ...`) or remove the TODO. Un-tracked TODOs rot.
4343
- **Unintended files**: review `git status` and `git diff --stat` to confirm only the files you meant to change are staged.
4444

45+
## PR description
46+
47+
Follow `.github/PULL_REQUEST_TEMPLATE.md` exactly. Use its section headings (`## Changes`, `## Why`, `## Tests`) in the same order, and fill each one in. Do not invent new sections (`## Summary`, `## Test plan`, etc.), do not drop sections, and do not leave the HTML comment placeholders in the final body — replace them with real content. If a section genuinely does not apply (e.g. a docs-only change has no test steps), say so explicitly under that heading rather than removing it.
48+
49+
When using `gh pr create`, read `.github/PULL_REQUEST_TEMPLATE.md` first and base `--body` on it.
50+
51+
If an agent (you) authored or substantially helped author the PR, disclose it on the last line of the body, e.g. `_This PR was written by Claude Code._` or `_PR description drafted with Claude Code._`. Be honest about the level of involvement — "written by" vs. "drafted with" vs. "reviewed by" — and keep it to a single italicized line so it doesn't crowd the template sections.
52+
4553
## Changelog entry
4654

4755
Add a `NEXT_CHANGELOG.md` entry when your change is user-visible. CI generates the real `CHANGELOG.md` from `NEXT_CHANGELOG.md` at release time, so never hand-edit `CHANGELOG.md` directly.

0 commit comments

Comments
 (0)