Git的提交說明(commit message)的編寫規範

格式

使用Angular 規範規範app

<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

通常來說,咱們只用第一行就能夠了。

相關文章
相關標籤/搜索