git是如今市面上最流行的版本控制工具，書寫良好的commit message能大大提升代碼維護的效率。可是在平常開發中因爲缺乏對於commit message的約束，致使填寫內容隨意、質量良莠不齊，可讀性低亦難以維護。在項目中引入commit message規範已經是迫在眉睫。node
1、市場主流規範
如今市面上比較流行的方案是約定式提交規範（Conventional Commits），它受到了Angular提交準則的啓發，並在很大程度上以其爲依據。約定式提交規範是一種基於提交消息的輕量級約定。它提供了一組用於建立清晰的提交歷史的簡單規則；這使得編寫基於規範的自動化工具變得更容易。這個約定與SemVer相吻合，在提交信息中描述新特性、bug 修復和破壞性變動。它的 message 格式以下:git
2、git commit 規範化工具 —— commitizen
1. 全局安裝commitizen & cz-conventional-changelog
commitizen是一個撰寫合格commit message的工具，用於代替git commit 指令，而cz-conventional-changelog適配器提供conventional-changelog標準（約定式提交標準）。基於不一樣需求，也可使用不一樣適配器。工具
安裝完畢後，可直接使用git cz來取代git commit。
全局模式下，須要 ~/.czrc 配置文件, 爲commitizen指定Adapter。 gitlab
2. 項目內安裝commitlint & husky
commitlint負責用於對commit message進行格式校驗，husky負責提供更易用的git hook。ui
commitlint只能作格式規範，沒法觸及內容。對於內容質量的把控只能靠咱們本身。 spa
3. 添加相應配置
建立commitlint.config.js.net
引入 husky版本控制
4. 使用
執行git cz進入interactive模式，根據提示依次填寫blog
生成的commit message格式以下：接口
填寫完畢後，husky會調用commitlint對message進行格式校驗，默認規定type及subject爲必填項。
任何git commit指令的option都能用在 git cz指令上, 例如git cz -a
3、Commit message規範在rrd-fe落地使用
1. type
type爲必填項，用於指定commit的類型，約定了feat、fix兩個主要type，以及docs、style、build、refactor、revert五個特殊type，其他type暫不使用。
當一次改動包括主要type與特殊type時，統一採用主要type。
2. scope
scope也爲必填項，用於描述改動的範圍，格式爲項目名/模塊名，例如：node-pc/commonrrd-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。參考文檔： User Docs | GitLab
填寫方式例如：
4、示例
一、完整的commit message示例
二、相應的git log
5、資料擴展
conventional commits 必讀 介紹約定式提交標準。
Angular規範 必讀 介紹Angular標準每一個部分該寫什麼、該怎麼寫。
@commitlint/config-conventional 必讀 介紹commitlint的校驗規則config-conventional，以及一些常見passes/fails狀況。
--------------------------------------
版權聲明：本文爲【PythonJsGo】博主的原創文章，轉載請附上原文出處連接及本聲明。
博主主頁：https://my.oschina.net/u/3375733
本篇文章同步在我的公衆號：