commit 提交规范

本文介绍了Git提交的规范,包括Header的type、scope和subject,Body和Footer的使用,并提到了Commitizen、commitlint & husky以及conventional-changelog等自动化工具,帮助开发者遵循提交规范并生成Change log。
摘要由CSDN通过智能技术生成

commit 格式

<type>(<scope>) : <subject>
<空行>
<body>
<空行>
<footer>
复制代码
  • type:本次提交的类别,必填
  • scope:影响范围,可以不填
  • subject:提交的标题,一句话概括提交的内容
  • body:详细描述提交的内容,可以不填
  • footer:放置写备注啥的,如果是 bug ,可以把bug id放入

Header

Header部分只有一行,包括三个字段:type(必需)、scope(可选)和subject(必需)

type

type用于说明 commit 的类别,只允许使用下面标识。

  • feat:新功能(feature)
  • fix:修补bug
  • docs:文档(documentation)
  • style: 格式(不影响代码运行的变动)
  • refactor:重构(即不是新增功能,也不是修改bug的代码变动)
  • test:增加测试
  • chore:构建过程或辅助工具的变动
  • merge:合并分支
  • perf:优化相关,比如提升性能、体验
  • revert:回滚到上一个版本
  • build:构建

如果 typefeatfix,则该 commit 将肯定出现在 Change log 之中。

scope

评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值