✅你作为项目组长,有制定过哪些规范吗?

✅你作为项目组长,有制定过哪些规范吗?

典型回答

简单列一下,供大家参考。

代码风格

1、主要是参考《阿里巴巴Java开发手册》来进行代码规约,要求所有成员都安装findbugs、p3c等插件,并且定期用插件扫描到问题,并及时修复。

2、idea中,大家使用通过的code style配置,避免格式化之后的代码冲突。

开发规范

1、定义主分支,如master,不允许在主分支提交代码,每次代码变更,需要从主分支上创建开发分支,在开发分支进行开发后,通过发布合并到master上。

2、代码每天下班前需要提交,并且提交前确保单元测试能跑通、代码启动无异常。

3、git提交信息中,需要清楚地描述修改内容,要求组内使用统一的提交信息格式。可参考:https://www.conventionalcommits.org/en/v1.0.0/

CodeReview

1、需要在项目过程中定期提交CR,而不是项目发布时一次性提交CR。CR必须通过后才能发布。

2、CR不能不看就直接通过。CR的问题需要都有所解决(可以先不发布,但是需要记录下来)

3、重点项目需要组织CR会议进行统一CR

单元测试

1、新代码需要有单元测试,要求新代码单测分支覆盖率达到80%

2、核心功能代码必须要有单元测试

3、单测不通过的代码不能提交,更不能发布

项目文档

1、 要求维护项目说明书、架构文档、API文档等,确保信息透明和可追溯。

2、 鼓励在代码中加入必要的文档说明,使用工具生成API文档(如Swagger)。

3、代码有变更,需要同时修改文档。

其他

1、项目周会一周一次,或者2周一次,主要是过风险和重要事项

2、日会,早上十分钟沟通下是否有重要卡点