Jireh 的个人博客 Jireh 的个人博客

记录分享生活、程序、信息的精彩人生

目录
Git提交规范
/  

Git提交规范

Git提交规范

格式:

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

<body>

<footer>

例子:

feat(user): Add user registration [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
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • perf:优化
  • test:增加测试
  • chore:构建过程或辅助工具的变动
  • revert:撤销上一次的 commit

scope [必须]

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

  • all:表示大范围的修改
  • loation:表示小范围的修改
  • module:表示修改了某个模块 例如:feat(user): add user login

subject [必须]

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

ISSUE_ID [可选]

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

body [可选]

body中就是 subject的详细说明

footer [可选]

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

commit-msg hook

如何保证每一次commit-msg信息格式的准备,可以是使用commit-msg hook

hook规则文件模板


标题:Git提交规范
作者:Jireh
地址:https://lyile.cn/articles/2020/04/13/1586763563287.html
本作品由 Jireh 采用 署名 – 非商业性使用 – 禁止演绎 4.0 国际许可协议进行许可,转载请注明出处。