gitcommit規(guī)范的有哪些

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

創(chuàng)新互聯(lián)建站專業(yè)為企業(yè)提供遂川網(wǎng)站建設(shè)、遂川做網(wǎng)站、遂川網(wǎng)站設(shè)計、遂川網(wǎng)站制作等企業(yè)網(wǎng)站建設(shè)、網(wǎng)頁設(shè)計與制作、遂川企業(yè)網(wǎng)站模板建站服務(wù)，10多年遂川做網(wǎng)站經(jīng)驗，不只是建網(wǎng)站，更提供有價值的思路和整體網(wǎng)絡(luò)服務(wù)。

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

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

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

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

看完什么感覺，寫的是啥啊（內(nèi)心 OS），這種 commit 信息對于想要從中獲取有效信息的人來說無疑是一種致命的打擊。

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

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

看完是不是一目了然呢？

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

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

Angular 團隊的 commit 規(guī)范

它的 message 格式如下:

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

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

Header

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

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

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

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

  •  subject: commit 目的的簡短描述

Body

對本次 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)前代碼與上一個版本不兼容) 或修復(fù)的 bug(關(guān)閉 Issue) 的鏈接。

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

git 提交信息模板

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

通過以下命令來配置提交信息模板:

git config commit.template   [模板文件名]    //這個命令只能設(shè)置當(dāng)前分支的提交模板  git config  &mdash; &mdash;global commit.template   [模板文件名]    //這個命令能設(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  #

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

commitizen（cz-cli）

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

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

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

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

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

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

  • 后面會讓你分別寫一個簡短的和詳細的提交描述:   

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

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

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

看完上面的 commitizen 的整個流程，下面讓我們來看下如何來安裝。

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

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

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

  •  本地項目安裝:   

# 安裝commitizen     $ npm install --save-dev commitizen     # 接下來安裝適配器     # 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是一個提交驗證工具。原理是可以在實際的 git commit 提交到遠程倉庫之前使用 git 鉤子來驗證信息。提交不符合規(guī)則的信息將會被阻止提交到遠程倉庫。

先來看一下演示:

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

對于 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)然如果你想單獨對 commitlint 進行配置的話，需要建立校驗文件 commitlint.config.js，不然會校驗失敗

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

husky 是一個增強的 git hook 工具。可以在 git hook 的各個階段執(zhí)行我們在 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

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

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

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

有沒有感覺很 cool~~

其實gitmoji的使用是很簡單的:

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

我們來看一下官方的示例吧:

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

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

本文題目：gitcommit規(guī)范的有哪些
當(dāng)前URL：http://bm7419.com/article38/jjcgpp.html

成都網(wǎng)站建設(shè)公司_創(chuàng)新互聯(lián)，為您提供定制網(wǎng)站、外貿(mào)建站、Google、網(wǎng)站建設(shè)、微信小程序、標(biāo)簽優(yōu)化

廣告

聲明：本網(wǎng)站發(fā)布的內(nèi)容（圖片、視頻和文字）以用戶投稿、用戶轉(zhuǎn)載內(nèi)容為主，如果涉及侵權(quán)請盡快告知，我們將會在第一時間刪除。文章觀點不代表本網(wǎng)站立場，如需處理請聯(lián)系客服。電話：028-86922220；郵箱：631063699@qq.com。內(nèi)容未經(jīng)允許不得轉(zhuǎn)載，或轉(zhuǎn)載時需注明來源： 創(chuàng)新互聯(lián)

網(wǎng)站優(yōu)化排名