Git commit message 規範

人人貸大前端技術中心發表於2019-06-20
GitMIT

Git commit message 規範

git是現在市面上最流行的版本控制工具，書寫良好的commit message能大大提高程式碼維護的效率。但是在日常開發中由於缺少對於commit message的約束，導致填寫內容隨意、質量參差不齊，可讀性低亦難以維護。在專案中引入commit message規範已是迫在眉睫。

用什麼規範？

現在市面上比較流行的方案是約定式提交規範（Conventional Commits），它受到了Angular提交準則的啟發，並在很大程度上以其為依據。約定式提交規範是一種基於提交訊息的輕量級約定。 它提供了一組用於建立清晰的提交歷史的簡單規則；這使得編寫基於規範的自動化工具變得更容易。這個約定與SemVer相吻合，在提交資訊中描述新特性、bug 修復和破壞性變更。它的 message 格式如下:

<型別>[可選的作用域]: <描述>

[可選的正文]

[可選的腳註]
複製程式碼

Quick Start

1. 全域性安裝commitizen & cz-conventional-changelog

commitizen是一個撰寫合格commit message的工具，用於代替git commit 指令，而cz-conventional-changelog介面卡提供conventional-changelog標準（約定式提交標準）。基於不同需求，也可以使用不同介面卡。

npm install -g commitizen cz-conventional-changelog
echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc
複製程式碼

安裝完畢後，可直接使用git cz來取代git commit。

全域性模式下，需要 ~/.czrc 配置檔案, 為commitizen指定Adapter。

2. 專案內安裝commitlint & husky

commitlint負責用於對commit message進行格式校驗，husky負責提供更易用的git hook。

Use npm

npm i -D husky @commitlint/config-conventional @commitlint/cli
複製程式碼

Use yarn

yarn add husky @commitlint/config-conventional @commitlint/cli -D
複製程式碼

commitlint只能做格式規範，無法觸及內容。對於內容質量的把控只能靠我們自己。

3. 新增相應配置

建立commitlint.config.js

# In the same path as package.json

echo 'module.exports = {extends: ["@commitlint/config-conventional"]};' > ./commitlint.config.js
複製程式碼

引入husky

# package.json

...,
"husky": {
    "hooks": {
      "commit-msg": "commitlint -e $GIT_PARAMS"
    }
}
複製程式碼

4. 使用

執行git cz進入interactive模式，根據提示依次填寫

1.Select the type of change that you're committing 選擇改動型別 (<type>)

2.What is the scope of this change (e.g. component or file name)? 填寫改動範圍 (<scope>)

3.Write a short, imperative tense description of the change: 寫一個精簡的描述 (<subject>)

4.Provide a longer description of the change: (press enter to skip) 對於改動寫一段長描述 (<body>)

5.Are there any breaking changes? (y/n) 是破壞性修改嗎？預設n (<footer>)

6.Does this change affect any openreve issues? (y/n) 改動修復了哪個問題？預設n (<footer>)
複製程式碼

生成的commit message格式如下：

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

填寫完畢後，husky會呼叫commitlint對message進行格式校驗，預設規定type及subject為必填項。

任何git commit指令的option都能用在 git cz指令上, 例如git cz -a

Commit message規範在rrd-fe落地使用情況

針對團隊目前使用的情況，我們討論後擬定了commit message每一部分的填寫規則。

1. type

type為必填項，用於指定commit的型別，約定了feat、fix兩個主要type，以及docs、style、build、refactor、revert五個特殊type，其餘type暫不使用。

# 主要type
feat:     增加新功能
fix:      修復bug

# 特殊type
docs:     只改動了文件相關的內容
style:    不影響程式碼含義的改動，例如去掉空格、改變縮排、增刪分號
build:    構造工具的或者外部依賴的改動，例如webpack，npm
refactor: 程式碼重構時使用
revert:   執行git revert列印的message

# 暫不使用type
test:     新增測試或者修改現有測試
perf:     提高效能的改動
ci:       與CI（持續整合服務）有關的改動
chore:    不修改src或者test的其餘修改，例如構建過程或輔助工具的變動
複製程式碼

當一次改動包括主要type與特殊type時，統一採用主要type。

2. scope

scope也為必填項，用於描述改動的範圍，格式為專案名/模組名，例如： node-pc/common rrd-h5/activity，而we-sdk不需指定模組名。如果一次commit修改多個模組，建議拆分成多次commit，以便更好追蹤和維護。

3. body

body填寫詳細描述，主要描述改動之前的情況及修改動機，對於小的修改不作要求，但是重大需求、更新等必須新增body來作說明。

4. break changes

break changes指明是否產生了破壞性修改，涉及break changes的改動必須指明該項，類似版本升級、介面引數減少、介面刪除、遷移等。

5. affect issues

affect issues指明是否影響了某個問題。例如我們使用jira時，我們在commit message中可以填寫其影響的JIRA_ID，若要開啟該功能需要先打通jira與gitlab。參考文件：docs.gitlab.com/ee/user/pro…

填寫方式例如：

re #JIRA_ID
fix #JIRA_ID
複製程式碼

示例

  • 完整的commit message示例
    Git commit message 規範
  • 相應的git log
    Git commit message 規範

最後慣例，歡迎大家star我們的人人貸大前端團隊部落格，所有的文章還會同步更新到知乎專欄 和 掘金賬號，我們每週都會分享幾篇高質量的大前端技術文章。如果你喜歡這篇文章，希望能動動小手給個贊。

擴充套件閱讀

conventional commits 必讀 介紹約定式提交標準。

Angular規範 必讀 介紹Angular標準每個部分該寫什麼、該怎麼寫。

@commitlint/config-conventional 必讀 介紹commitlint的校驗規則config-conventional，以及一些常見passes/fails情況。

相關文章