提交规范

提交信息由 Header、 Body 、Footer 三部分组成，Header 又包含 Type、Scope 和 Subject 三部分。格式如下：

Type(Scope):Subject

Body

Footer

Header、Body、Footer 三者之间用一个空行分隔。

Header

Header 包含 3 部分信息分别是：Type（必须）、Scope 和 Subject（必须）。格式如下：

Type(Scope):Subject

1. Type 用以说明提交的类别，建议的标识如下：

• feat：新功能开发
• fix：修复 BUG
• docs：文档更新
• style：代码格式调整，不影响代码整体运行
• refactor：代码重构（没有新功能，也没有修复 BUG）
• perf：性能优化
• test：更新测试内容（包括增加）
• build：影响构建系统或外部依赖项的更改(Maven、Gradle、npm 等)
• ci：CI 配置文件修改，如：Travis、Circle、BrowserStack、SauceLabs
• chore：对非 src 和 test 的文件目录的修改
• revert：撤销之前提交

2. Scope 用以说明本次提交的影响范围，一般根据具体项目进行填写，比如业务域、架构层级等，文字尽量简短
3. Subject 用以对本次提交的概括说明，推荐以动词开头，如： 设置、修改、增加、删减、撤销等，且不超过 50 个字符。

Body

Subject 是对本次提交的概括性说明，而 Body 部分是对本次提交的详细说明，可以写多行。

Footer

Footer 在开发中不常用。

• 如果 Type 为 feat，Footer 可以关联到具体的需求 id，或者 ISSUE id
• 如果 Type 是 fix，则可以关联到 BUG id
• 如果 Type 是 revert，则可以关联到上次的 Version Number。

如：

Close #001
BUG #001
ISSUE #001
REVERT #8d1e4b4f68736a4332c1e442d97c3d8ed82cef56

Git Commit Template 插件使用

在日常开发中，团队人多的时候严格按照前面的规范进行是比较困难的，至少会出现拼写错误等问题。Jetbrains 家族的工具中可以通过安装 Git Commit Template 插件约束大家的规范。

安装以及使用如下：

其它

• 提交代码之前先拉取最新代码
• 用命令合并多个 Commit (opens new window)