溫馨提示×

您好，登錄后才能下訂單哦！

密碼登錄×
登錄注冊(cè)×
其他方式登錄
點(diǎn)擊 登錄注冊(cè) 即表示同意《億速云用戶服務(wù)條款》

git commit規(guī)范的有哪些

發(fā)布時(shí)間：2021-11-03 13:50:27 來(lái)源：億速云 閱讀：152 作者：iii 欄目：web開(kāi)發(fā)

本篇內(nèi)容介紹了“git commit規(guī)范的有哪些”的有關(guān)知識(shí)，在實(shí)際案例的操作過(guò)程中，不少人都會(huì)遇到這樣的困境，接下來(lái)就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細(xì)閱讀，能夠?qū)W有所成！

為什么要規(guī)范 git commit

一直在說(shuō)要規(guī)范 commit 格式，那為什么要這樣做呢？

讓我們先來(lái)看一個(gè)不太規(guī)范的 commit 記錄:

git commit規(guī)范的有哪些

看完什么感覺(jué)，寫(xiě)的是啥?。▋?nèi)心 OS），這種 commit 信息對(duì)于想要從中獲取有效信息的人來(lái)說(shuō)無(wú)疑是一種致命的打擊。

那我們來(lái)看一個(gè)社區(qū)里面比較流行的Angular規(guī)范的 commit 記錄:

git commit規(guī)范的有哪些

看完是不是一目了然呢？

上圖中這種規(guī)范的 commit 信息首先提供了更多的歷史信息，方便快速瀏覽。其次，可以過(guò)濾某些 commit（比如文檔改動(dòng)），便于快速查找信息。

既然說(shuō)到了 Angular 團(tuán)隊(duì)的規(guī)范是目前社區(qū)比較流行的 commit 規(guī)范，那它具體是什么呢？下面讓我們來(lái)具體深入了解下吧。

Angular 團(tuán)隊(duì)的 commit 規(guī)范

它的 message 格式如下:

<type>(<scope>): <subject>  // 空一行  <body>  // 空一行  <footer>

分別對(duì)應(yīng) Commit message 的三個(gè)部分：Header，Body 和 Footer。

Header

Header 部分只有一行，包括三個(gè)字段：type（必需）、scope（可選）和subject（必需）。

  •  type: 用于說(shuō)明 commit 的類型。一般有以下幾種: 

feat: 新增feature    fix: 修復(fù)bug    docs: 僅僅修改了文檔，如readme.md    style: 僅僅是對(duì)格式進(jìn)行修改，如逗號(hào)、縮進(jìn)、空格等。不改變代碼邏輯。    refactor: 代碼重構(gòu)，沒(méi)有新增功能或修復(fù)bug    perf: 優(yōu)化相關(guān)，如提升性能、用戶體驗(yàn)等。    test: 測(cè)試用例，包括單元測(cè)試、集成測(cè)試。    chore: 改變構(gòu)建流程、或者增加依賴庫(kù)、工具等。    revert: 版本回滾

  •  scope: 用于說(shuō)明 commit 影響的范圍，比如: views, component, utils, test...

  •  subject: commit 目的的簡(jiǎn)短描述

Body

對(duì)本次 commit 修改內(nèi)容的具體描述, 可以分為多行。如下圖:

# body: 72-character wrapped. This should answer:  # * Why was this change necessary?  # * How does it address the problem?  # * Are there any side effects?  # initial commit

Footer

一些備注, 通常是 BREAKING CHANGE(當(dāng)前代碼與上一個(gè)版本不兼容) 或修復(fù)的 bug(關(guān)閉 Issue) 的鏈接。

簡(jiǎn)單介紹完上面的規(guī)范，我們下面來(lái)說(shuō)一下commit.template，也就是 git 提交信息模板。

git 提交信息模板

如果你的團(tuán)隊(duì)對(duì)提交信息有格式要求，可以在系統(tǒng)上創(chuàng)建一個(gè)文件，并配置 git 把它作為默認(rèn)的模板，這樣可以更加容易地使提交信息遵循格式。

通過(guò)以下命令來(lái)配置提交信息模板:

git config commit.template   [模板文件名]    //這個(gè)命令只能設(shè)置當(dāng)前分支的提交模板  git config  &mdash; &mdash;global commit.template   [模板文件名]    //這個(gè)命令能設(shè)置全局的提交模板，注意global前面是兩杠

新建 .gitmessage.txt(模板文件) 內(nèi)容可以如下:

# headr: <type>(<scope>): <subject>  # - type: feat, fix, docs, style, refactor, test, chore  # - scope: can be empty  # - subject: start with verb (such as 'change'), 50-character line  #  # body: 72-character wrapped. This should answer:  # * Why was this change necessary?  # * How does it address the problem?  # * Are there any side effects?  #  # footer:  # - Include a link to the issue.  # - BREAKING CHANGE  #

看完上面這些，你會(huì)不會(huì)像我一樣感覺(jué)配置下來(lái)挺麻煩的，配置一個(gè)適合自己和團(tuán)隊(duì)使用的近乎完美的 commit 規(guī)范看來(lái)也不是一件容易的事情。不過(guò)社區(qū)也為我們提供了一些輔助工具來(lái)幫助進(jìn)行提交，下面來(lái)簡(jiǎn)單介紹一下這些工具。

commitizen（cz-cli）

commitizen是一款可以交互式建立提交信息的工具。它幫助我們從 type 開(kāi)始一步步建立提交信息，具體效果如圖所示:

git commit規(guī)范的有哪些

  •   首先通過(guò)上下鍵控制指向你想要的 type 類型，分別對(duì)應(yīng)有上面提到的feat、fix、docs、perf等:   

git commit規(guī)范的有哪些

  • 然后會(huì)讓你選擇本次提交影響到的文件:   

git commit規(guī)范的有哪些

  • 后面會(huì)讓你分別寫(xiě)一個(gè)簡(jiǎn)短的和詳細(xì)的提交描述:   

git commit規(guī)范的有哪些

  • 最后會(huì)讓你去判斷本次提交是否是BREAKING CHANGE或者有關(guān)聯(lián)已開(kāi)啟的issue:

git commit規(guī)范的有哪些

看完上面的 commitizen 的整個(gè)流程，下面讓我們來(lái)看下如何來(lái)安裝。

  •  全局環(huán)境下安裝:

commitizen 根據(jù)不同的adapter配置 commit message。例如，要使用 Angular 的 commit message 格式，可以安裝cz-conventional-changelog。 

# 需要同時(shí)安裝commitizen和cz-conventional-changelog，后者是adapter     $ npm install -g commitizen cz-conventional-changelog     # 配置安裝的adapter     $ echo '{ "path": "cz-conventional-changelog" }' > ~/.czrc     # 使用     $ git cz

  •  本地項(xiàng)目安裝:   

# 安裝commitizen     $ npm install --save-dev commitizen     # 接下來(lái)安裝適配器     # for npm >= 5.2     $ npx commitizen init cz-conventional-changelog --save-dev --save-exact     # for npm < 5.2     $ ./node_modules/.bin/commitizen init cz-conventional-changelog --save-dev --save-exact     // package.json script字段中添加commit命令     "scripts": {        "commit": "git-cz"     }     // use     $ npm run commit

commitlint

commitlint是一個(gè)提交驗(yàn)證工具。原理是可以在實(shí)際的 git commit 提交到遠(yuǎn)程倉(cāng)庫(kù)之前使用 git 鉤子來(lái)驗(yàn)證信息。提交不符合規(guī)則的信息將會(huì)被阻止提交到遠(yuǎn)程倉(cāng)庫(kù)。

先來(lái)看一下演示:

git commit規(guī)范的有哪些

對(duì)于 Conventional Commits 規(guī)范，社區(qū)已經(jīng)整理好了 @commitlint/config-conventional 包，我們只需要安裝并啟用它就可以了。

首先安裝 commitlint 以及 conventional 規(guī)范:

npm install --save-dev @commitlint/cli @commitlint/config-conventional

接著在 package.json 中配置 commitlint 腳本:

"commitlint": {      "extends": [        "@commitlint/config-conventional"      ]    },

當(dāng)然如果你想單獨(dú)對(duì) commitlint 進(jìn)行配置的話，需要建立校驗(yàn)文件 commitlint.config.js，不然會(huì)校驗(yàn)失敗

為了可以在每次 commit 時(shí)執(zhí)行 commitlint 來(lái) 檢查我們輸入的 message，我們還需要用到一個(gè)工具 &mdash;&mdash; husky。

husky 是一個(gè)增強(qiáng)的 git hook 工具?？梢栽?git hook 的各個(gè)階段執(zhí)行我們?cè)?package.json 中配置好的 npm script。

首先安裝 husky:

npm install --save-dev husky

接著在 package.json 中配置 commitmsg 腳本:

"husky": {      "hooks": {        "commit-msg": "commitlint -E HUSKY_GIT_PARAMS"      }   },

到這里，commitlint就配置完成了～

gitmoji-cli

平時(shí)與朋友聊天時(shí)，我們一定會(huì)用到表情包，比如。表情包的出現(xiàn)讓我們與朋友之間的溝通變得更加有趣。如果能在 git 提交 commit 時(shí)用到表情包()，豈不是使每次的 commit 能夠更加直觀，維護(hù)起來(lái)也更加方便。

git commit規(guī)范的有哪些

gitmoji就是可以實(shí)現(xiàn)這種功能的插件，先讓我們來(lái)感受一下

有沒(méi)有感覺(jué)很 cool~~

其實(shí)gitmoji的使用是很簡(jiǎn)單的:

# 安裝  npm i -g gitmoji-cli  # 使用  git commit -m ':bug: 問(wèn)題fix'

我們來(lái)看一下官方的示例吧:

git commit規(guī)范的有哪些

“git commit規(guī)范的有哪些”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)可以關(guān)注億速云網(wǎng)站，小編將為大家輸出更多高質(zhì)量的實(shí)用文章！

向AI問(wèn)一下細(xì)節(jié)

免責(zé)聲明：本站發(fā)布的內(nèi)容（圖片、視頻和文字）以原創(chuàng)、轉(zhuǎn)載和分享為主，文章觀點(diǎn)不代表本網(wǎng)站立場(chǎng)，如果涉及侵權(quán)請(qǐng)聯(lián)系站長(zhǎng)郵箱：is@yisu.com進(jìn)行舉報(bào)，并提供相關(guān)證據(jù)，一經(jīng)查實(shí)，將立刻刪除涉嫌侵權(quán)內(nèi)容。

AI
助
手