Git的提交说明（commit message）的编写规范

时间 2019-12-09

标签 git 提交说明 commit message 编写规范栏目 Git 繁體版

原文原文链接

格式

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

其中，head 是必需的，body 和 footer 能够省略。工具

type用于说明 commit 的类别，只容许使用下面7个标识：测试

    feat：新功能（feature）
    fix：修补bug
    docs：文档（documentation）
    style：格式（不影响代码运行的变更）
    refactor：重构（即不是新增功能，也不是修改bug的代码变更）
    test：增长测试
    chore：构建过程或辅助工具的变更google

scope用于指明commit 影响的范围spa

subject用于说明commit 的概述code

body用于说明commit 具体修改内容, 能够分为多行xml

footer:用于两种状况, rem

（1） BREAKING CHANGE文档

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

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

通常来说，咱们只用第一行就能够了。