點(diǎn)擊上方“小黃鴨編程社區(qū)”，選擇“星標(biāo)”

作者：人人貸大前端技術(shù)中心來(lái)源：https://urlify.cn/3a6NNb

git是現(xiàn)在市面上最流行的版本控制工具，書(shū)寫(xiě)良好的commit message能大大提高代碼維護(hù)的效率。但是在日常開(kāi)發(fā)中由于缺少對(duì)于commit message的約束，導(dǎo)致填寫(xiě)內(nèi)容隨意、質(zhì)量參差不齊，可讀性低亦難以維護(hù)。在項(xiàng)目中引入commit message規(guī)范已是迫在眉睫。

# 用什么規(guī)范？

現(xiàn)在市面上比較流行的方案是約定式提交規(guī)范(Conventional Commits)，它受到了Angular提交準(zhǔn)則的啟發(fā)，并在很大程度上以其為依據(jù)。約定式提交規(guī)范是一種基于提交消息的輕量級(jí)約定。它提供了一組用于創(chuàng)建清晰的提交歷史的簡(jiǎn)單規(guī)則；這使得編寫(xiě)基于規(guī)范的自動(dòng)化工具變得更容易。這個(gè)約定與SemVer相吻合，在提交信息中描述新特性、bug 修復(fù)和破壞性變更。它的 message 格式如下:

[可選的作用域]: [可選的正文][可選的腳注]

#?Quick Start

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

commitizen是一個(gè)撰寫(xiě)合格commit message的工具，用于代替git commit 指令，而cz-conventional-changelog適配器提供conventional-changelog標(biāo)準(zhǔn)(約定式提交標(biāo)準(zhǔn))?；诓煌枨?#xff0c;也可以使用不同適配器。

npm install -g commitizen cz-conventional-changelogecho '{ "path": "cz-conventional-changelog" }' > ~/.czrc

安裝完畢后，可直接使用git cz來(lái)取代git commit。

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

2、項(xiàng)目?jī)?nèi)安裝commitlint & husky

commitlint負(fù)責(zé)用于對(duì)commit message進(jìn)行格式校驗(yàn)，husky負(fù)責(zé)提供更易用的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只能做格式規(guī)范，無(wú)法觸及內(nèi)容。對(duì)于內(nèi)容質(zhì)量的把控只能靠我們自己。

3、添加相應(yīng)配置

創(chuàng)建commitlint.config.js

# In the same path as package.jsonecho 'module.exports = {extends: ["@commitlint/config-conventional"]};' > ./commitlint.config.js

引入husky

# package.json...,"husky": {"hooks": {"commit-msg": "commitlint -e $GIT_PARAMS" }}

4、使用

執(zhí)行g(shù)it cz進(jìn)入interactive模式，根據(jù)提示依次填寫(xiě)。

1.Select the type of change that you're committing 選擇改動(dòng)類(lèi)型 ()2.What is the scope of this change (e.g. component or file name)? 填寫(xiě)改動(dòng)范圍 ()3.Write a short, imperative tense description of the change: 寫(xiě)一個(gè)精簡(jiǎn)的描述 ()4.Provide a longer description of the change: (press enter to skip) 對(duì)于改動(dòng)寫(xiě)一段長(zhǎng)描述 ()5.Are there any breaking changes? (y/n) 是破壞性修改嗎？默認(rèn)n ()6.Does this change affect any openreve issues? (y/n) 改動(dòng)修復(fù)了哪個(gè)問(wèn)題？默認(rèn)n ()

生成的commit message格式如下：

():

填寫(xiě)完畢后，husky會(huì)調(diào)用commitlint對(duì)message進(jìn)行格式校驗(yàn)，默認(rèn)規(guī)定type及subject為必填項(xiàng)。

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

# Commit message規(guī)范在rrd-fe落地使用情況

針對(duì)團(tuán)隊(duì)目前使用的情況，我們討論后擬定了commit message每一部分的填寫(xiě)規(guī)則。

1、type

type為必填項(xiàng)，用于指定commit的類(lèi)型，約定了feat、fix兩個(gè)主要type，以及docs、style、build、refactor、revert五個(gè)特殊type，其余type暫不使用。

# 主要typefeat: 增加新功能fix: 修復(fù)bug# 特殊typedocs: 只改動(dòng)了文檔相關(guān)的內(nèi)容style: 不影響代碼含義的改動(dòng)，例如去掉空格、改變縮進(jìn)、增刪分號(hào)build: 構(gòu)造工具的或者外部依賴的改動(dòng)，例如webpack，npmrefactor: 代碼重構(gòu)時(shí)使用revert: 執(zhí)行g(shù)it revert打印的message# 暫不使用typetest: 添加測(cè)試或者修改現(xiàn)有測(cè)試perf: 提高性能的改動(dòng)ci: 與CI(持續(xù)集成服務(wù))有關(guān)的改動(dòng)chore: 不修改src或者test的其余修改，例如構(gòu)建過(guò)程或輔助工具的變動(dòng)

當(dāng)一次改動(dòng)包括主要type與特殊type時(shí)，統(tǒng)一采用主要type。

2、scope

scope也為必填項(xiàng)，用于描述改動(dòng)的范圍，格式為項(xiàng)目名/模塊名，例如：

node-pc/common rrd-h5/activity，而we-sdk不需指定模塊名。如果一次commit修改多個(gè)模塊，建議拆分成多次commit，以便更好追蹤和維護(hù)。

3、body

body填寫(xiě)詳細(xì)描述，主要描述改動(dòng)之前的情況及修改動(dòng)機(jī)，對(duì)于小的修改不作要求，但是重大需求、更新等必須添加body來(lái)作說(shuō)明。

4、break changes

break changes指明是否產(chǎn)生了破壞性修改，涉及break changes的改動(dòng)必須指明該項(xiàng)，類(lèi)似版本升級(jí)、接口參數(shù)減少、接口刪除、遷移等。

5、affect issues

affect issues指明是否影響了某個(gè)問(wèn)題。例如我們使用jira時(shí)，我們?cè)赾ommit message中可以填寫(xiě)其影響的JIRA_ID，若要開(kāi)啟該功能需要先打通jira與gitlab。參考文檔：docs.gitlab.com/ee/user/pro…

填寫(xiě)方式例如：

re #JIRA_IDfix #JIRA_ID

#?示例

完整的commit message示例

相應(yīng)的git log

# 擴(kuò)展閱讀

conventional commits 必讀 介紹約定式提交標(biāo)準(zhǔn)。

Angular規(guī)范 必讀 介紹Angular標(biāo)準(zhǔn)每個(gè)部分該寫(xiě)什么、該怎么寫(xiě)。

@commitlint/config-conventional 必讀 介紹commitlint的校驗(yàn)規(guī)則config-conventional，以及一些常見(jiàn)passes/fails情況。

-?END -

# 熱文推薦

為什么在密碼問(wèn)題上，char[]優(yōu)先于String？

阿里的離職率真的是互聯(lián)網(wǎng)大廠里最低的嗎?

35歲騰訊員工被裁員感嘆：北京一套房，存款700多萬(wàn)，失業(yè)好焦慮

喜歡文章，點(diǎn)個(gè)在看?

創(chuàng)作挑戰(zhàn)賽新人創(chuàng)作獎(jiǎng)勵(lì)來(lái)咯，堅(jiān)持創(chuàng)作打卡瓜分現(xiàn)金大獎(jiǎng)

總結(jié)

以上是生活随笔為你收集整理的eclipse git提交代码_来看看大厂的Git提交规范，千万别乱提交代码哦...的全部?jī)?nèi)容，希望文章能夠幫你解決所遇到的問(wèn)題。

如果覺(jué)得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。