← 中文资源

简体中文版本

以辅导为目的的评审工作流

让评审意见传递推理与标准,使团队整体提升而非只修好当前变更。

阅读英文原文

目标

代码评审应用来提升团队技能与共享标准,而非只修好当前变更。本工作流要求对每项修改说明理由以传递可迁移的原则,明确区分必须修改与可选建议以便作者排优先级,引用书面标准或既有示例而非个人偏好,并在意图不明时以提问代替假设。

步骤要点

  1. 对每项修改说明理由以传递原则。
  2. 明确区分必须修改与可选建议。
  3. 引用书面标准或既有示例。
  4. 意图不明时以提问代替假设。
# label comment severity in the review
[blocking] this leaks the connection on error
[suggestion] consider extracting this helper

验证

按顺序执行上述步骤后,逐项确认每个步骤的预期状态均已满足;只有全部预期状态成立,才认为本流程完成。若某一步未达到预期状态,应先按排错提示排查,不要跳过继续,以免掩盖问题。

排错提示

  • 只下命令不教原则无法传递知识。
  • 混同阻断与可选会让优先级不清。
  • 未解释的偏好会令作者受挫。

适用边界

  • 格式类问题应自动化。
  • 人工评审聚焦实质。