首页/开发/代码质量与评审速查/合并前检查(pre-merge checklist)
代码评审64 条

合并前检查(pre-merge checklist)

点合并前快速核对:CI 全绿、批准齐全、讨论已解决、目标分支正确、无冲突与调试残留;赶时间时这些项更不能跳过。

合并前核对什么

点下合并按钮之前的核对很短,但每一项都对应一类真实事故:流水线全绿、批准齐全(含路径负责人)、所有讨论已解决、目标分支与基准正确、没有冲突与调试残留、版本号与变更日志就绪。赶时间的时候这些项更不能跳过——事故通常发生在「这次应该没事」的判断上。

基本信息

检查时机评审通过、准备合并之前
必查项流水线状态、批准齐全、讨论已解决、目标分支正确
容易漏项调试残留、临时开关状态、变更日志与版本号
时机判断高风险改动避免在周末或长假前合并

合并前检查

合并前检查
1. CI 全部通过(含 lint、测试)
2. 所需批准已齐(含 Code Owner)
3. 所有对话已解决(Resolve conversation)
4. 目标分支与基准正确,无冲突
5. 版本号、变更日志、开关状态就绪
6. 合并方式与提交信息符合团队规范

容易被忽略的几项

  • 目标分支写错:合到错误的长期分支上,回退需要额外操作。
  • 调试代码与临时日志残留:合并前再扫一眼 diff。
  • 功能开关状态:上线时期望的默认值是否与代码一致。
  • 关联文档与部署说明:需要在合并后同步更新的内容是否准备好。
  • 监控与告警:新功能是否有可观测指标,出问题能否第一时间发现。

检查项与风险

检查项漏掉的后果
CI 状态未覆盖的变更直接进主干
批准齐全规则要求的复核实际没有发生
讨论已解决遗留问题无人跟进,事后无记录
目标分支改动进入错误分支,需要额外回退
时机选择出问题时只有值班同学兜底
高风险改动临近周末合并:出事只有值班同学兜底,时机本身也是评审的一部分。
合并后顺手做的两件事:确认部署与监控正常、删除已合并的临时分支,避免环境越堆越乱。

易错点

  • 看都不看直接点绿色按钮:CI 未覆盖的变更照样出问题。
  • 合并后忘记清理分支与看监控:环境越堆越乱,问题发现延迟。
  • 目标分支选错:改动进入错误分支,需要额外的回退与重放。
  • 赶在假期前合并高风险改动:出问题时响应人手最少。

数据来源与参考

  • GitHub Docs · Merging a pull request(合并前状态)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌