1 工作流规范
1.1 Git规范
Git 分支命名
项目常驻分支
- master：主分支，负责记录上线版本的迭代，该分支代码与线上代码是完全一致的。
- pre：封测分支。预发布的分支代码。
- stage：测试分支。提测后用于测试的分支代码。
开发分支
均由 master 分支创建，并同步到远程
- 业务开发分支，命名为
英文名/神兵用户故事需求单号形如leon/CDP00060-1，(如无单号，可用需求英文代替)并同步到远程，功能上线后删除该分支 - 紧急bug修复，命名为
英文名/hotfix，并同步到远程，功能上线后删除该分支
Git Commit Message格式
type : subject
| type 提交类型 | subject 提交描述 |
|---|---|
| feat：新增feature | 对应内容是commit 目的的简短描述，一般不超过50个字符 |
| fix：修复bug | |
| docs：仅仅修改了文档，比如README, CHANGELOG等 | |
| style：仅仅修改了空格，格式缩进，不改变代码逻辑 | |
| refactor：代码重构，没有加新功能或者修复bug | |
| perf：优化相关，比如提升性能，体验 | |
| chore：改变构建流程、或者增加依赖库、工具等 |
1.2 开发流程
- 开发人员从 master 新建开发分支，
英文名/jira单号 - 本地开发完成后 git merge 到 stage 分支
- stage 测试通过, 到 pre 分支下执行 git merge
英文名/jira单号 - pre 测试通过, 到 master 分支执行 git merge
英文名/jira单号 - 打 Tag 格式如 v202008121509 当前的时间，精确到分
- 运维从最新 Tag 发布代码
2 编码规范
2.1 格式化规范
使用统一 .prettierrc 并配合 vscode prettier 插件格式化项目代码
- 缩进空格数为2个
- 语句末尾省略分号
- 使用单引号而非双引号
- 对象拖尾逗号
- 在对象字面量声明所使用的的花括号后（{）和前（}）输出空格
2.2 js 规范
命名
- 变量：小驼峰、前缀名词
- 常量：全部大写、多个单词时使用分隔符_
- 函数：小驼峰、前缀动词
其他
-
常量需单独存放。以功能为命名自解释。特殊需注释说明 -
条件判断逻辑多时，开发时建议使用变量将单个条件提取或函数封装，并写明注释 -
函数- 函数参数不宜过多，超过3个以上的参数考虑对象封装
- 用准确的函数名自解释
- 函数遵循
单一职责，功能过多过重的函数建议解耦单独封装功能
-
代码尽量
减少重复。重复出现2-3次建议封装 -
不要在代码库中遗留被注释掉的代码
-
代码健壮性。考虑潜在异常或错误处理。例如：错误捕获 -
考虑代码
性能和效率
