Git提交规范

Git提交规范
Git Hook - 实现commit-msg自动装饰

格式:

<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的规范和相关科普知识 git commit 的规范要求(参考Angular团队) message格式如下: ...
    达文西_Huong阅读 4,155评论 0 0
  • Git 提交规范 制定一个 git commit 信息的提交规范是开发团队工作流必不可少的环节。试想一下,如果查看...
    十月里的男艺术家阅读 4,187评论 0 0
  • 前言在提交commit信息时,为了统一规范commit信息,可以在Git Hooks中编写修改commit-msg...
    Cuccci阅读 2,801评论 1 0
  • 久违的晴天,家长会。 家长大会开好到教室时,离放学已经没多少时间了。班主任说已经安排了三个家长分享经验。 放学铃声...
    飘雪儿5阅读 12,186评论 16 22
  • 今天感恩节哎,感谢一直在我身边的亲朋好友。感恩相遇!感恩不离不弃。 中午开了第一次的党会,身份的转变要...
    迷月闪星情阅读 13,585评论 0 11