Git 提交规范

作者:zheng_Great 2020-04-17 3567次

先来看看公式:

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

  

  • 【卡号】feat:新功能(feature)

    【卡号】fix:修补bug

    【卡号】docs:文档(documentation)

    【卡号】style: 格式(不影响代码运行的变动)

    【卡号】refactor:重构(即不是新增功能,也不是修改bug的代码变动)

    【卡号】test:增加测试

    【卡号】chore:构建过程或辅助工具的变动

    【卡号】doning: 开发中

    【卡号】done: 已完成

    【卡号】import:到入库



type:

用于说明 commit 的类别,只允许使用特定的几个标识。

 

feat:

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

 

scope:

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

 

subject:

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

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


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