gh-pr-description
GitHub用于撰写和审查 GitHub PR 描述,引导以变更原因为核心,提供结构化模板与发布命令指导。
Trigger Scenarios
Install
npx skills add vercel/eve --skill gh-pr-description -g -y
SKILL.md
Frontmatter
{
"name": "gh-pr-description",
"description": "Drafts and reviews GitHub pull request descriptions for the eve repository. Use when opening, updating, or reviewing a PR, or when summarizing a branch for reviewers."
}
GitHub PR description
Inspect the branch diff, commits, related issue or discussion, tests, docs, and changesets. When updating a PR, read its current body first.
Write
Fill in .github/pull_request_template.md. Write for a reviewer, not a
changelog:
- Keep the Summary to one short paragraph: usually 2–4 sentences and about 100 words or fewer.
- Lead with the concrete problem, user need, or decision behind the change; follow with the solution and meaningful behavior. Prefer short sentences; split independent points rather than combining them into a long sentence.
- Do not list files or narrate commits. Include implementation detail only when it is necessary to assess behavior or risk.
- Mention breaking changes, preserved behavior, tradeoffs, scope boundaries, follow-ups, or stacked PRs only when they matter to review.
- Link an existing issue or discussion with
Closes #N,Related to #N, or an equivalent when one exists. Do not create an issue solely for a PR. - State only validation that actually ran, including limitations or failures.
Preserve the checklist and check only verified items.
Publish
Before publishing, confirm the Summary leads with why the change is needed.
Write the body to a file, then pass it to gh pr create or gh pr edit with
--body-file.
Version History
-
9cb899d
Current 2026-09-08 22:20
简化技能内容,强调 PR 描述应以变更原因为开头。
-
a77ae1b
2026-08-27 12:10
澄清贡献者关于 Issue 的政策,明确链接 Issue 的规则。
-
73d381e
2026-08-16 20:14
新增Diff size章节规范,要求按文档、实现、测试分类统计变更并解释原因;精简摘要写作指引。
-
5cc74a6
2026-08-12 13:15
强化精简 PR 描述的要求,增加对风险、范围及验证细节的明确指引。
- 84c3dfc 2026-08-06 12:49
- e5c9191 2026-08-05 19:10


