代码审查指南

主要观点:作者整理了关于代码审查的建议,包括关注测试、结对或带作者一起审查、引入清单/问卷、良好的沟通方式、避免使用“请求更改”功能、考虑文化多样性、作为 PR 作者的注意事项等方面。
关键信息

  • 测试很重要,应重视测试,优先写规格说明(specs)而非单纯测试,考虑写“场景”测试。
  • 可选择结对或带作者审查,引入清单/问卷覆盖重要变更属性。
  • 沟通时使用标签明确意图和语气,避免误解,如[strong]、[bug]等。
  • 不要使用“请求更改”功能,除非对作者有帮助。
  • 要考虑文化多样性,假设他人有良好意图。
  • 作为 PR 作者,不要太在意代码,认真对待评论,确保 PR 描述和提交易读,先自己审查等。
    重要细节
  • 规格说明应清晰易懂,如测试框架的 spec-ing DSL 或用注释代替。
  • 清单/问卷应避免被忽视,鼓励提供更多背景,使额外评论更易被注意。
  • 沟通风格可参考网上指南,同事还提到“屎三明治”技巧。
  • 代码提交历史应清晰,PR 描述应提供整体概述。
  • 给出了团队的代码审查问卷模板作为示例。
阅读 12
0 条评论