如何提交規範的 git commit message

時間 2019-12-18

標籤如何提交規範 git commit message 欄目 Git 简体版

原文原文鏈接

規範化 commit message 的做用

提供更多的歷史信息
能夠篩選提交內容
能夠直接從commit生成Change log

下面展現一下小編的 commit messagenode

這是生成的 CHANGELOGgit

如今開始介紹如何去編寫規範的 commit message

git commit message 格式

目前規範使用較多的是 Angular 團隊的規範, 繼而衍生了 Conventional Commits specification. 不少工具也是基於此規範, 它的 message 格式以下:github

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
複製代碼

每一個提交消息由header，body和footer組成，其中 body 和 footer 能夠省略express

Header

header只有一行，包括三個字段：type（必需）、scope（可選）和subject（必需）json

type 用於說明 commit 的類別

feat 一項新功能
fix 錯誤修復
docs 文檔
style 不影響代碼含義的更改（空格，格式，缺乏分號等）
refactor 代碼更改既不修復錯誤也不添加功能
perf：改進性能的代碼更改
test 添加缺失或更正現有測試
chore 對構建過程或輔助工具和庫（如文檔生成）的更改

scope 範圍

範圍能夠是指定提交更改位置的任何內容，能夠*在更改影響多個範圍時使用bash

subject 主題

這次commit的簡潔描述，不超過50個字符, 推薦使用英語提交commit。app

使用命令式，使用"change" 不是 "changed" 也不是 "changes"
不要把第一個字母大寫
最後沒有點 .

body 主體

body 部分是對本次 commit 的詳細描述，能夠分紅多行，好比描述與提交以前有什麼不一樣。ide

footer 頁腳

兼容性

全部重大更改都必須做爲頁腳中的更改塊說起，它應以「BREAKING CHANGE」一詞開頭：空一到兩行。而後，提交消息的其他部分是對更改，理由和遷移說明的描述。工具

BREAKING CHANGE: isolate scope bindings definition has changed and
    the inject option for the directive controller injection was removed.
    
    To migrate the code follow the example below:
    
    Before:
    
    scope: {
      myAttr: 'attribute',
      myBind: 'bind',
      myExpression: 'expression',
      myEval: 'evaluate',
      myAccessor: 'accessor'
    }
    
    After:
    
    scope: {
      myAttr: '@',
      myBind: '@',
      myExpression: '&',
      // myEval - usually not useful, but in cases where the expression is assignable, you can use '='
      myAccessor: '=' // in directive's template change myAccessor() to myAccessor } The removed `inject` wasn't generaly useful for directives so there should be no code using it.

複製代碼

issue

關閉 issus 應該在頁腳的單獨行中列出，前綴爲「Closes」關鍵字，以下所示：性能

Closes #234
// 多個
Closes #123, #245, #992
複製代碼

更多內容參考

舉個栗子

這是我本身項目提交時使用的message, 你們能夠參考，下面是手動敲的，可使用工具 commitizen/cz-cli, 自動生成標準的commit message, 在此很少介紹

feat: write log message into file

Put log message into appoint dir, it will create the dir if not exist

複製代碼

refactor(package.json): update nodejs version and license

The version was 1.0.0, the license was ISC before update, and now, the version is 0.0.1, license is MIT

複製代碼

更多栗子