软件开发规范

       前沿：由于项目前期任务重，时间短等其他原因导致的开发不规范，引起后期维护比较复杂。

一、目前存在问题

        1）项目分支较多，命名不规范。

        2）代码注释不完善，函数名称自注释性较差。

        3）缺少长链路功能的技术方案设计和流程图。

        4）数据库注释较少，脚本执行容易遗漏。

二、解决方案

       1）开发阶段统一代码风格，遵守、但可不严格执行《阿里巴巴java开发手册》

       2）定期做codeReivew，对复杂功能进行分享

       3）规范版本控制如下：

                a):规范git commit信息：第一行：作者: 功能模块名称，第二行：修改描述

                b)规范分支名称：

                · master: 与线上同步分支(仅项目负责人拥有提交、合并等权限)

                · release: 将 master 分支和需要提测的分支汇总到一个 release 分支，

                                发布测试环境,命名规范release+版本号

                 ·feature:新需求或新的研究创建一个feature,          

                  命名规则：f-分支创建日期-新特性关键字，例如：f-20210808-实时转写；

                 ·hotfix:热修复分支,临时紧急处理线程缺陷

                  命名规则：h-分支创建日期-bug名称和待发布版本号，

                   例如：h-202108081614- 修复实时转写v2.0.1;   

                c)规范tag命名：tag命名格式为 Tag命名规则： 类型 - 版本号 - 期次号
                          例：master-v3.0.1-20210812-1153

        4）规范开发流程如下：

         

三、愿景

        愿服务永不宕机、用户量蹭蹭上涨，软件平稳运行100年。