【规范建设】git commit 规范化指南

前言

目的规范化团队的代码提交管理，方便与明确知道提交记录的目的。

便于程序员对提交历史进行追溯，了解发生了什么情况。

一旦约束了 commit message，意味着我们将慎重的进行每一次提交，不能再一股脑的把各种各样的改动都放在一个 git commit 里面，这样一来整个代码改动的历史也将更加清晰。

格式化的 commit message 才可以用于自动化输出 Change log。

提交预览

<类型>[可选范围]: <描述>

1	<type>(<scope>): <subject>

参数说明：

scope(可选)
   scope用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。
   例如在Angular，可以是location, browser, compile, compile, rootScope,
   ngHref, ngClick, ngView等。如果你的修改影响了不止一个scope，你可以使用*代替。

subject(必须)
   subject是commit目的的简短描述，不超过50个字符。
   建议使用中文（感觉中国人用中文描述问题能更清楚一些）。
   结尾不加句号或其他标点符号。

用于说明 git commit 的类别，只是允许使用下面的标识。

以下表格来自阿里技术

标识	含义
`build`	主要目的是修改项目构建系统(例如 glup，webpack，rollup 的配置等)的提交
`docs`	文档更新（documentation）
`feat`	新增功能（feature）
`fix`	修复 bug，可以是 QA 发现的 BUG，也可以是研发自己发现的 BUG。
`perf`	优化相关，比如提升性能、体验
`style`	不影响程序逻辑的代码修改(修改空白字符，格式缩进，补全缺失的分号等，没有改变代码逻辑)
`test`	增加测试
`chore`	不修改 src 或者 test 的其余提交, 例如构建过程或辅助工具的变动
`merge`	分支合并 Merge branch ? into ?
`refactor`	重构（即不是新增功能，也不是修改 bug 的代码变动）
`revert`	回滚某个更早之前的提交
`sync`	同步主线或分支的 Bug
`ci`	与 CI(持续集成服务)有关的改动

scope(可选)

1、scope 用于说明 commit 影响的范围，比如数据层、控制层、视图层等等，视项目不同而不同。

2、例如在 Angular，可以是 location，browser，compile，compile，rootScope，ngHref，ngClick， ngView 等。如果你的修改影响了不止一个 scope，你可以使用*代替。

subject(必须)

1、subject 是 commit 目的的简短描述，不超过 50 个字符。
2、``（感觉中国人用中文描述问题能更清楚一些）。 3、结尾不加句号或其他标点符号。

// 严谨commit提交规范
fix(DAO): 登录功能表单缺少phone字段
feat(Controller): 用户查询接口开发

// 通常开发commit提交规范
feat：注册功能模块开发
feat：登录功能模块开发
fix：修复注册表单正则预校验
fix：修复登录表单正则预校验

vscode commit 规范化工具

vscode 中Git-commit-plugin插件可以快速生成提交模板。

设置项

展示 Emoji

默认为 true。可在设置中修改

提交类型

增加其他的提交类型，需要在 json 中添加。、

"GitCommitPlugin.CustomCommitType": [
  {
    "label": "customTypeName",
    "detail": "customTypeDetail"
  }
]

subject 最大长度

subject 的最大长度限制，默认为 20。可在设置中修改。

前言

提交预览

vscode commit 规范化工具

其他

文献参考