适用场景
- 写完功能后需要补 PR 描述
- 希望标题说明「为什么」,而不是堆砌文件名
- 团队约定需要 Summary + Test plan 结构
推荐模型与消耗
- 推荐模型:
claude-sonnet-4-20250514 - 预估消耗: 约 1k–4k tokens / 次
使用步骤
- 准备
git diff或已暂存变更说明 - 可选补充:业务背景、关联 Issue
- 使用下方 Prompt 生成中文 PR 文案
- 人工校对后粘贴到 GitHub / GitLab
Prompt
根据以下变更生成 PR 文案(中文):
要求:
- 标题:祈使句,聚焦动机(why),不超过 72 字符
- Summary:1–3 条要点
- Test plan:可勾选清单
- 若有破坏性变更或迁移,单独标出
不要编造未在 diff 中出现的功能。不确定处用「待确认」。
变更内容:
<在此粘贴 diff 或文件级摘要>
失败排查
| 现象 | 处理 |
|---|---|
| 标题像文件清单 | 补充「用户可感知的结果」一句背景 |
| Test plan 太空 | 写明你实际跑过的命令与页面路径 |
| 中英混杂 | 明确要求「标题与正文全部中文」 |