欢迎光临
我们一直在努力

Git的提交说明(commit message)的编写规范

格式

使用Angular 规范规范

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

其中,head 是必需的,body 和 footer 可以省略。

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

    feat:新功能(feature)
    fix:修补bug
    docs:文档(documentation)
    style: 格式(不影响代码运行的变动)
    refactor:重构(即不是新增功能,也不是修改bug的代码变动)
    test:增加测试
    chore:构建过程或辅助工具的变动

scope用于指明commit 影响的范围

subject用于说明commit 的概述

body用于说明commit 具体修改内容, 可以分为多行

footer:用于两种情况, 

    (1) BREAKING CHANGE

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

BREAKING CHANGE: isolate scope bindings definition has changed.

    To migrate the code follow the example below:

    Before:

    scope: {
      myAttr: 'attribute',
    }

    After:

    scope: {
      myAttr: '@',
    }

    The removed `inject` wasn't generaly useful for directives so there should be no code using it.

    (2)关闭issue

Closes #123, #245, #992

举例

fix(app):修复app中的推送的BUG

这是body

这是footer

一般来讲,我们只用第一行就可以了。

 

未经允许不得转载:ITyet » Git的提交说明(commit message)的编写规范

评论 抢沙发

  • 昵称 (必填)
  • 邮箱 (必填)
  • 网址
打开看板娘