Skip to content

Commit 1476a87

Browse files
authored
Let LLMs create less noisy and more focused PR descriptions (vercel#94896)
The default template is too noisy when used by LLMs. "what" and "how" are almost always duplicates. Verification most often includes trivial commands (e.g. static checking of .js files or running `pnpm build`). This information isn't relevant to review and can leave the important bits of a PR description unreviewed. Oftentimes the "why" is the most important bit for maintainers. The "what" is most important for end users reading along (or for deriving docs or changelog entries from the PR).
1 parent 00df19b commit 1476a87

1 file changed

Lines changed: 10 additions & 11 deletions

File tree

.agents/skills/create-pr/SKILL.md

Lines changed: 10 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -70,26 +70,25 @@ Use this skill when turning local work into a GitHub pull request.
7070
Use this PR body format:
7171

7272
```markdown
73-
### What?
73+
## Summary
7474

75-
<what changed>
75+
<what changed and why>
7676

77-
### Why?
78-
79-
<why this is needed>
80-
81-
### How?
82-
83-
<implementation approach>
84-
85-
### Verification
77+
## Verification
8678

8779
- `<command that passed>`
8880
- Not run: `<command>` (`<reason>`)
8981

9082
<!-- NEXT_JS_LLM_PR -->
9183
```
9284

85+
The "what" should be explained from the end-user perspective or developer perspective. Only include implementation changes if they're not obvious from the diff.
86+
87+
A "why" should be included if the change isn't self-explanatory, or if the motivation is not clear from the diff.
88+
Omitting the "why" should be used sparringly and only for small changes.
89+
90+
Do not include trivial verification commands that CI already covers (e.g. `pnpm run build`), but do include any manual verification steps. If the PR changes a test, you don't need to repeat the command to run that test. But if you used an existing test to validate some behavior didn't change, include that test.
91+
9392
Use `--body` with this filled content.
9493

9594
## Recovery

0 commit comments

Comments
 (0)