首页/开发/代码质量与评审速查/提交前自审:先读一遍自己的 diff
代码评审64 条

提交前自审:先读一遍自己的 diff

请评审前的自审步骤:通读完整 diff、删除调试残留与无关文件、确认注释与描述准确、跑一遍本地校验与测试。

自审命令示例

自审命令示例
git diff            # 通读工作区改动
git diff --stat     # 先看文件清单与规模
git diff --check    # 查空白错误与冲突标记
# 再看:调试输出、注释掉的代码、TODO、临时文件是否清掉
  • 把 diff 当作别人的代码来读,找回不应出现的内容
  • 确认没有把无关文件(本地配置、日志、测试数据)带进提交
一次自审通常能省下一轮评审往返,性价比高。

易错点

  • 跳过自审直接请人评审:低级问题消耗评审者注意力
  • 只跑测试不看 diff:调试代码与误提交文件照样进评审

数据来源与参考

  • Google Engineering Practices · The CL Author's Guide(自审建议)
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌