一、目的
在多人協作項目，如果代碼風格統一、提交信息准確，那么在后期協作以及BUG處理時會更加方便。
格式化的commit message有以下幾個好處：
1. 方便快速檢索歷史提交信息，只看行首即可知曉commit的目的
git log HEAD --pretty=format:%s
2. 可以過濾某些commit(比如文檔更新)，便於快速查找信息
git log HEAD --pretty=format:%s --grep 新功能
3. 可以直接從commit生成changelog，說明與上一版本發布的差異
通過changelog，測試知曉本次變更修改范圍
二、格式
每一次提交，信息都必須遵循commit信息格式，包含Header、Body、Footer三個部分。
commit信息格式
三、工具
3.1 依賴安裝
# 安裝所需依賴, changelog-sn至少2.x版本
npm install -D changelog-sn standard-version
3.2 配置commitlint和commitizen
代碼倉庫根目錄創建文件
.commitlintrc.js和.czconfigrc.js
3.2.1 配置.commitlintrc.js內容
module.exports = Object.assign({}, require('changelog-sn/lib/lint'), { rules: { 'subject-empty': [2, 'never'], 'type-empty': [2, 'never'], 'scope-empty': [2, 'never'], 'type-enum': [ 2, 'always', [ '新功能', '修復', '優化', '重構', '文檔', 'chore', 'revert', 'WIP', 'docs', 'build', 'release' ] ] } }) 3.2.2 配置.czconfigrc.js
module.exports = { types: [ { value: '新功能', name: '新功能 : 新增加一個功能' }, { value: '修復', name: '修復 : 一個 bug 修復' }, { value: '優化', name: '優化 : 提升性能的代碼更改' }, { value: '重構', name: '重構 : 不涉及修復bug和新功能開發的代碼更改' }, { value: '文檔', name: '文檔 : 只有文檔發生改變' }, { value: 'chore', name: '構建 : 修改持續集成的配置文件和腳本' }, { value: 'revert', name: '撤銷 : 撤銷一個歷史提交' }, { value: 'WIP', name: '待完成 : 研發中的提交備份' } ], messages: { type: '選擇你提交的信息類型:', scope: '選擇本次提交的改變所影響的范圍？', customScope: '本次提交的改變所影響的范圍？', subject: '寫一個簡短的變化描述，盡量包含主謂賓結構，杜絕簡單的單詞：\n', body: '提供更詳細的變更描述 (按 enter 跳過). 使用 "|" 換行：\n', breaking: '列出所有的不兼容變更 (按 enter 跳過)：\n', footer: '列出此次改動解決的所有 issues （如："#123, #234"）(按 enter 跳過)：\n', confirmCommit: '確認提交以上內容信息？' }, allowBreakingChanges: ['refactor', 'chore'], breakingPrefix: 'WARNING:', skipQuestions: ['body'], subjectLimit: 100, breaklineChar: '|', footerPrefix: 'CLOSED:' } 3.2.3 配置package.json
{ "scripts": { "log": "changelog-sn -i CHANGELOG.md -s -r 2", "cz": "git add . && git cz" }, "husky": { "hooks": { "commit-msg": "commitlint -E HUSKY_GIT_PARAMS" } }, "config": { "commitizen": { "path": "./node_modules/cz-customizable" }, "cz-customizable": { "config": "./.czconfigrc.js" } }, "devDependencies": { "changelog-sn": "2.0.5" } }作者：逆黃
鏈接：https://www.jianshu.com/p/d20ecbc66ae1
來源：簡書
著作權歸作者所有。商業轉載請聯系作者獲得授權，非商業轉載請注明出處。