Git commit 规范

74 阅读1分钟

Git commit 规范

<type>(<scope>): <subject> [<ISSUE_ID>]

<body>

<footer>

例子:

feat(user): Add user login [777]

Use Tencent cloud verification code to verify mobile phone 
and add user registration function

https://github.com/one-user/a-project/issues/777

type [必须]

用于说明 commit 的类别,只允许使用下面几种标识:

● feat:新功能(feature)

● fix:修补 bug

● delete: 删除功能

● style: 样式相关

● merge:合并代码

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

● perf:优化

● revert:撤销上一次的 commit

● docs:文档(documentation)

● test:增加测试

● chore:构建过程或辅助工具的变动

scope [必须]

用于说明修改的范围,基本上有有以下几种情形:

scope:表示修改了某个模块 例如:feat(user): add user login

subject [必须]

用于表示本次提交修改的简要说明,尽量简短

ISSUE_ID [可选]

添加在 git issues 中需求或者 bug 修复对应的 issues 记录ID

body [可选]

body中就是 subject的详细说明

footer [可选]

可以写备注,填写相关的需求管理 issues id