Git commit message 規範

時間 2019-11-07

標籤 git commit message 規範欄目 Git 简体版

原文原文鏈接

git是如今市面上最流行的版本控制工具，書寫良好的commit message能大大提升代碼維護的效率。可是在平常開發中因爲缺乏對於commit message的約束，致使填寫內容隨意、質量良莠不齊，可讀性低亦難以維護。在項目中引入commit message規範已經是迫在眉睫。html

用什麼規範？

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

<類型>[可選的做用域]: <描述>

[可選的正文]

[可選的腳註]
複製代碼

Quick Start

1. 全局安裝commitizen & cz-conventional-changelog

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

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

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

全局模式下，須要 ~/.czrc 配置文件, 爲commitizen指定Adapter。git

2. 項目內安裝commitlint & husky

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

Use npmweb

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

Use yarnnpm

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

commitlint只能作格式規範，沒法觸及內容。對於內容質量的把控只能靠咱們本身。json

3. 添加相應配置

建立commitlint.config.jsbash

# 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。