Scrum 小册子 - 如何做代码审查(Code Review - Lite)

—— Code Review 是一种文化,而非制度。

目标

  • 提高代码质量和可读性
  • 共享知识与编程技巧
  • 给予有意义的反馈帮助小伙伴们成长

注:因为“旁观者清,当局者迷”,所以需要伙伴的帮助来发现个人的不足。

时机

代码待合并且完成以下步骤:

原则

  • 代码逻辑是否简单明了?
  • 代码是否符合公司规范?
  • 单次 Review 时间建议少于 30 分,不超过 60 分(可分批 Review)
  • 单次查阅建议少于 400 行,不超过 1000 行
  • 确保代码逻辑正确,安全可靠、可读性强(而非个人偏好)
  • 不要在 Review 中讨论需求(Review 是 Review,Planning 是 Planning)
  • 面对面给予正向反馈(文明用语,尊重彼此,保持互相学习的心态)

注:没有完美的代码,不要纠结。

关注清单

  • 代码规范
  • 设计模式 (JavaScript)
  • 质量属性
    • 可靠性
    • 可维护性
    • 可扩展性
    • 可伸缩性
    • 可读性
    • 安全
    • 性能
    • ...

根据团队需要定制规范

Google Review 指南

英文原版:https://github.com/google/eng-practices

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容