首页/开发/代码质量与评审速查/PR 描述要素:背景、改动、验证
代码评审64 条

PR 描述要素:背景、改动、验证

评审友好的 PR 描述模板:说明背景与动机、改动范围与关键决策、验证方式与结果、以及风险与回滚方式。

PR 描述模板

PR 描述模板
## 背景
为什么需要这个改动(问题、影响面)

## 改动
- 关键变化与设计取舍
- 不在本次范围的内容

## 验证
- 执行的测试与命令、结果
- 手工验证步骤(如可复现)

## 风险与回滚
- 风险点、监控项、回滚方式
描述服务三类读者:评审者(现在)、发布同学(上线时)、未来的自己(排障时)。

易错点

  • 描述只贴工单链接:评审者还要跨系统找上下文
  • 验证部分只写'本地测过':没有可核对的信息

数据来源与参考

  • Google Engineering Practices · The CL Author's Guide(描述写作)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌