基本原则
- 尊重PR提交者
- 代码首先是给人看的 ，然后才是让计算机运行的
- IDEA安装阿里的代码规范插件
- 在保证需求的前提下，尽量控制技术债务的规模
- 后台Java代码规范遵照阿里Java代码规范执行
- 前台JS暂时规范参考Google规范执行
发起PR规范
- 每个 Pull Request 只做一件事
- 避免超大的 PR
- 记录下自己提交的原因
- 提交前，执行阿里代码规范插件的规范性检查，解决提示的全部
- 提交前，执行代码格式化保证风格的一致
- 有单元测试编写能力的人员，单元测试应覆盖全部逻辑，测试覆盖率应超过70%
- 保证代码能够100%自测试，并且进行真正测试
- 较大规模的提交需要交由测试人员测试后确认没有问题再提交PR
- 提交后检查CI构建结果
- 尽量回复所有评论，尊重评论者对 PR 的关心
PR评审规范
-
尊重PR提交者，评论和意见都要是建议性的而不是批判性的
-
如果意见不太确定建议与提交人员
-
检查代码实现与需求是否一致
-
检查代码实现与接口设计或架构设计是否保持一致
-
检查代码中方法，变量，类的命名是否规范
- 类采用名词，大驼峰命名，比如EmailProcesser
- 方法采用动词，小驼峰命名，比如validEmail
- 变量采用名词，小驼峰命名
- 静态变量采用大写下划线的模式
-
检查是否有明显安全漏洞，比如明文的密码，未加密的敏感信息
-
检查代码或设计中是否有对操作系统或环境的依赖，特别是考察是否有对于windows的依赖，原则上是不容许有这样的依赖，如无法避免需要技术负责人确认
-
综合考虑项目需求，进度和技术，世界没有完美的，需求必然出现变化，技术债务做到可控即可
