commit 规范

基本格式:

每次提交,Commit message 都包括三个部分:Header,Body 和 Footer。

<type>(<scope>): <subject>
// 空一行
<body>
// 空一行
<footer>

Header 是必需的,Body 和 Footer 可以省略。

1. Header

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

  • type用于说明Commit的类型,包含一下7种类型
feat:新功能(feature)
fix:修补bug
docs:文档(documentation)
style: 格式(不影响代码运行的变动)
refactor:重构(即不是新增功能,也不是修改bug的代码变动)
test:增加测试
chore:构建过程或辅助工具的变动
perf:提高性能
  • scope用于说明本次Commit所影响的范围,比如controller、user或者README,视项目的不同而不同。

  • subject
    subject是本次Commit目的的简短描述,一般不要超过50个字符

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

2. Body

Body 部分是对本次 commit 的详细描述,可以分成多行
实例:

More detailed explanatory text, if necessary.  Wrap it to
about 72 characters or so.

Further paragraphs come after blank lines.

- Bullet points are okay, too
- Use a hanging indent

应该说明代码变动的动机,以及与以前行为的对比,参考前文提到的 注释要回答如下信息。

3. Footer

Footer 部分只用于不兼容变动和关闭 Issue。

  • 不兼容改动
    如果当前代码与上一个版本不兼容,则 Footer 部分以BREAKING CHANGE开头,后面是对变动的描述、以及变动理由和迁移方法。

  • 关闭Issue
    如果当前Commit是针对某个Issue的提交,那么久可以在Footer中关闭这个Issue:Closes #234

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值