GIT COMMIT 写法的含义

commitizen详解
Message 格式
一般来说,Commit Message 应包含三部分内容:Header、Body、Footer

():
// 空一行

// 空一行


1
2
3
4
5
Header
Header部分应只包含一行,包括三个字段:type、scope和subject

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

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

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

1
2
3
Body
Body是对本地提交的一个详细描述,下面是一个示例

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
    1
    2
    3
    4
    5
    6
    7
    Footer
    Footer只用于两种情况

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

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

猜你喜欢

转载自blog.csdn.net/xuzhoubin110/article/details/79895087