代码审查指南

审查者清单

  • 代码是否符合PR描述的功能?
  • 新代码是否有足够的测试覆盖?
  • 是否可能破坏现有功能?
  • 错误处理是否全面?
  • 是否存在安全问题?(SQL注入、XSS、认证绕过)
  • 代码是否可读且命名合理?
  • 文档/注释是否更新?
  • 性能:是否有N+1查询、缺少索引、阻塞调用?
  • 是否遵循团队编码规范?
  • 依赖变更是否合理?

作者清单(提交前)

  • 已自我审查 diff
  • 本地所有测试通过
  • 无调试代码或 console.log 遗留
  • PR 小而专注(< 400行)
  • 描述解释了"为什么"而不只是"做了什么"
  • UI 变更已添加截图
  • 破坏性变更已明确记录

评论语气指南

不要说改为说
这是错的考虑处理...的情况
你为什么这样做?能帮我理解...的原因吗?
这代码写得很差这可以简化为...
你必须...我认为这样会更好...

评论严重性标签

标签含义
[blocking]合并前必须解决
[suggestion]可选改进
[nit]小的风格/命名问题
[question]寻求澄清
[praise]表扬好的工作