Git 提交规范

Posted 2021-02-05 saytome

规范参考：Commit message 和 Change log 编写指南。

 

先来看看公式：

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

　　

• feat：【卡号】新功能（feature）
• fix：【卡号】修补bug
• docs：【卡号】文档（documentation）
• style： 【卡号】格式（不影响代码运行的变动）
• refactor：【卡号】重构（即不是新增功能，也不是修改bug的代码变动）
• test：【卡号】增加测试
• chore：【卡号】构建过程或辅助工具的变动
• doning: 【卡号】开发中
• done: 【卡号】已完成
• import：【卡号】到入库

type：

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

 

feat：

新功能（feature） fix：修补bug docs：文档（documentation） style： 格式（不影响代码运行的变动） refactor：重构（即不是新增功能，也不是修改bug的代码变动） test：增加测试 chore：构建过程或辅助工具的变动

 

scope：

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

 

subject：

是 commit 目的的简短描述，不超过50个字符。

1.以动词开头，使用第一人称现在时，比如change，而不是changed或changes 2.第一个字母小写 3.结尾不加句号（.）