首页/开发/Git 与协作速查/在评审中标注 nit 与阻塞项
协作与代码评审75 条

在评审中标注 nit 与阻塞项

用 nit: 前缀标出不阻塞的小建议,用 must/阻塞 明确合入条件;统一用语能减少「到底要不要改」的反复确认。

Git 与协作速查开发更新于 2026-10-12
nit风格或偏好建议,可改可不改
阻塞项必须修改,如正确性、安全、数据兼容问题
建议格式前缀标签 + 理由 + 可行改法

评论示例

评论示例
nit: 这里可以合并两个 if,非阻塞
blocking: 该分支缺少错误处理,空输入会 panic,请补充
question: 这个超时值有依据吗?建议附上来源
对 nit 集中批量说明,不要在大量小事上逐条阻塞合入;把精力留给高风险问题。

易错点

  • 不给前缀直接提意见,作者无法判断阅读优先级
  • 同一个 nit 反复出现时,应改为文档或自动化检查,而不是反复人工提醒

数据来源与参考

  • Google Engineering Practices:How to write code review comments
  • GitHub Docs:Reviewing changes
​‌‌​​‌​​​‌‌​‌‌‌‌​‌‌​​​‌‌​‌‌‌​​‌‌​​‌​‌‌‌​​‌‌‌​​​‌​‌‌​‌​​‌​‌‌‌​​​‌​‌‌​‌​​‌​‌‌​​​‌‌​‌‌‌​‌​​​‌‌​‌‌‌‌​​‌​‌‌‌​​‌‌​​​‌‌​‌‌​‌‌‌‌​‌‌​‌‌​‌