代码提交规范必要性

1. 统一格式的提交记录，更清晰和易读
2. 可以通过提交记录来了解本次提交的目的，更好的CR和重构
3. 更容易了解变更，定位和发现问题
4. 每个提交描述都是经过思考的，改善提交质量
5. 自动化生成 CHANGELOG。
6. 基于提交的类型，自动决定语义化的版本变更。
7. 让人们探索一个更加结构化的提交历史，以便降低对你的项目做出贡献的难度。

代码提交规范

在业界常用的：atom，eslint和Angular等规范中, 我们选择最常用的Angular规范进行微调，作为我们日常项目中的提交规范，规范模板如下：

<type>(<STORY/REQ>): <description>
   │        │         │
   │        │         └─⫸ 代码提交描述内容，例如：指标平台多数据源demoui前端开发
   │        │
   │        └─⫸ Jira STORY编号或REQ编号，例如：REQ-1234
   │
   └─⫸ 提交类型: feat|fix|docs|style|build|refactor|revert|test|perf|ci|chore

注意：冒号后面有一个空格

示例：feat(REQ-1234): 指标平台多数据源demoui前端开发

Type 必须是以下的类型：

• feat：新增页面或功能
• fix：bug修复
• docs：只改动了文档相关的内容
• style：不影响代码含义的改动，例如去掉空格、改变缩进、增删分号
• build ：构 造 工 具的 或 者 外 部 依 赖 的 改 动 ， 例 如 webpack，npm，pom
• refactor：代码重构时使用,重构（既不是新增功能，也 不是修改 bug 的代码变动）
• revert：执行 git revert 回退类型的提交信息
• test：添加测试或者修改现有测试
• perf: 性能提升改动
• ci：对 CI 配置文件和脚本的更改
• chore：不修改 src 或者 test 的其余修改，例如构建过 程或辅助工具的变动

GIT代码提交注释插件

• 下载插件：Git Commit Template Check

• 配置插件

• 使用插件