Skip to content

Latest commit

 

History

History
31 lines (18 loc) · 1.58 KB

how-to-review-code.md

File metadata and controls

31 lines (18 loc) · 1.58 KB

如何审核代码

审核代码的注意点

不要评论代码风格

“不要评论代码风格”不意味着不要注意代码风格。保证项目的可维护性之一,就是要有统一的代码风格。
代码风格检查应该是一个自动化的过程,比如使用 ESLint 自动检测 JS 代码风格。一旦不符合既定规范,就报错。

因为在 code review 中评审代码风格是件低效的,且可能会导致额外争论的事。
能够自动化处理的都要避免人为去参与,评审人应该将宝贵的时间去检验代码的正确性。
所以团队应该有一套自己的代码风格配置文件。任何关于代码风格的问题,不应该在项目 PR 中讨论,而应该在管理代码风格配置文件的项目/群组里协商。

减少审核成本

比如对于前端代码审核,会有很多改变,这时候如果有端到端测试会很大程度减少审核成本。要么自己在不同的浏览器里亲自测试前端代码是否正确。

面对几十个文件几百行代码的改动,只是审核代码,可能会有很大负担,且不能保证正确性。

更改的范围

一处很小的改动,可能会影响到整个功能的运行,甚至多个系统的交互。

我们要了解改动所影响的范围,不能只针对改动所在的文件进行代码审核。

每次更新都需要审核

参考