首页/开发/Git 与协作速查/PR/MR 描述要素
协作与代码评审75 条

PR/MR 描述要素

一份可评审的描述通常包含:变更目的、实现要点、验证方式、影响面与风险、关联单号;写清这些能减少来回追问。

Git 与协作速查开发更新于 2026-10-12
推荐结构背景/目的 → 改动内容 → 验证方式 → 影响与风险 → 关联项
验证方式列出执行的命令、测试用例、手动验证步骤
关联项Closes #123 / Ref !45

描述示例

描述示例
## 目的
修复分页参数溢出导致的服务端 500。
## 改动
- 分页参数改为整型校验并加边界测试
## 验证
- go test ./pkg/pagination/...
- 手动验证 /api/list?page=-1
## 风险
无接口字段变化。
描述里贴关键日志或截图时要脱敏;涉及配置变更的,写出回滚方式。

易错点

  • 只写「见提交」会迫使评审者逐个翻提交,关键信息缺失时评审质量下降
  • 描述与实际改动脱节(后来改代码没更新描述)会误导评审结论

数据来源与参考

  • GitHub Docs:About pull requests(描述与模板)
  • GitLab Docs:Merge request descriptions
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌