Commit Message 規範

時間 2019-12-10

標籤 commit message 規範简体版

原文原文鏈接

統一團隊 Git commit 日誌標準，便於後續代碼 review ，版本發佈以及日誌自動化生成等等。
統一團隊的Git工做流，包括分支使用、tag 規範、issue 等。

Git commit日誌基本規範

<type>(<scope>): <subject> 
<BLANK LINE> 
<body> 
<BLANK LINE> 
<footer>

對格式的說明以下：html

type表明某次提交的類型，好比是修復一個bug仍是增長一個新的feature。全部的type類型以下：git

feat：新增feature
fix: 修復bug
docs: 僅僅修改了文檔，好比README, CHANGELOG, CONTRIBUTE等等
style: 僅僅修改了空格、格式縮進、都好等等，不改變代碼邏輯
refactor: 代碼重構，沒有加新功能或者修復bug
perf: 優化相關，好比提高性能、體驗
test: 測試用例，包括單元測試、集成測試等
chore: 改變構建流程、或者增長依賴庫、工具等
revert: 回滾到上一個版本

格式要求：

# 標題行：50個字符之內，描述主要變動內容

# 主體內容：更詳細的說明文本，建議72個字符之內。 須要描述的信息包括:

# * 爲何這個變動是必須的? 它多是用來修復一個bug，增長一個feature，提高性能、可靠性、穩定性等等

# * 他如何解決這個問題? 具體描述解決問題的步驟

# * 是否存在反作用、風險? 

# 尾部：若是須要的化能夠添加一個連接到issue地址或者其它文檔，或者關閉某個issue。

Commit messages書寫建議

儘量多的提交，單個Commit messages包含的內容不要過多；
標題行以Fix, Add, Change, Delete開始，採用命令式的模式。不要使用Fixed, Added, Changed等等；
始終讓第二行是空白，不寫任何內容；
主體內容注意換行，避免在gitk裏面滾動條水平滑動；
永遠不在 git commit 上增長 -m 或 --message= 參數，提交的時候git commit便可；
若是你是vim用戶，將下面這行代碼加入到~/.vimrc。這會幫助你檢查拼寫和自動換行。 autocmd Filetype gitcommit setlocal spell textwidth=72

使用Commitizen工具

Commitizen可讓你的commit message更加規範統一，適合項目團隊使用，使用也很簡單，使用npm安裝後，提交代碼的時候使用git cz去替代之前的git commit命令便可。
安裝commitizen：npm

npm install -g commitizen

使用截圖：vim

自動生成Change log工具

conventional-changelog是用來從git的元數據中生成 Change log文檔的工具，只要你提交的格式知足它定義的標準，此處以angular標準爲例子。使用它生成的Change log包含如下三個部分：post

Bug Fixes Bug修復的信息
Features 增長的特性
BREAKING CHANGES 重大變動

能夠參考它生成的文檔CHANGELOG.md，使用以下：性能

$ npm install -g conventional-changelog-cli 
$ cd my-project
$ conventional-changelog -p angular -i CHANGELOG.md -s

Git分支與版本發佈規範

基本原則：master爲保護分支，不直接在master上進行代碼修改和提交。單元測試

開發平常需求或者項目時，從master分支上checkout一個feature分支進行開發或者bugfix分支進行bug修復，功能測試完畢而且項目發佈上線後，將feature分支合併到主幹master，而且打Tag發佈，最後刪除開發分支。分支命名規範：
分支版本命名規則：分支類型分支發佈時間分支功能。好比：feature_20170401_fairy_flower測試
- 分支類型包括：feature、 bugfix、refactor三種類型，即新功能開發、bug修復和代碼重構
- 時間使用年月日進行命名，不足2位補0
- 分支功能命名使用snake case命名法，即下劃線命名。
Tag包括3位版本，前綴使用v。好比v1.2.31。Tag命名規範：優化
- 新功能開發使用第2位版本號，bug修復使用第3位版本號
- 核心基礎庫或者Node中間價能夠在大版本發佈請使用灰度版本號，在版本後面加上後綴，用中劃線分隔。alpha或者belta後面加上次數，即第幾回alpha：
  - v2.0.0-alpha-1
  - v2.0.0-belta-1

版本正式發佈前須要生成changelog文檔，而後再發布上線。

參考資料

Commit message 和 Change log 編寫指南阮一峯
 如何寫好 Git commit messages 騰訊IVWEB團隊
 如何寫好 Git commit log? 知乎
 優雅的提交你的 Git Commit Message 阿里
 你可能會忽略的 Git 提交規範掘金

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。