溫馨提示×

溫馨提示×

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

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

Git commit message和工作流規(guī)范的原理介紹

發(fā)布時(shí)間：2021-06-26 09:43:01 來源：億速云 閱讀：154 作者：chen 欄目：大數(shù)據(jù)

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

目的

  • 統(tǒng)一團(tuán)隊(duì)Git commit日志標(biāo)準(zhǔn)，便于后續(xù)代碼review，版本發(fā)布以及日志自動(dòng)化生成等等。

  • 統(tǒng)一團(tuán)隊(duì)的Git工作流，包括分支使用、tag規(guī)范、issue等

Git commit日志參考案例

  • angular

  • commit-message-test-project

  • babel-plugin-istanbul

  • conventional-changelog

總體方案

Git commit message和工作流規(guī)范的原理介紹

Git commit日志基本規(guī)范

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

對格式的說明如下：

  • type代表某次提交的類型，比如是修復(fù)一個(gè)bug還是增加一個(gè)新的feature。所有的type類型如下：

  • feat： 新增feature

  • fix: 修復(fù)bug

  • docs: 僅僅修改了文檔，比如README, CHANGELOG, CONTRIBUTE等等

  • style: 僅僅修改了空格、格式縮進(jìn)、都好等等，不改變代碼邏輯

  • refactor: 代碼重構(gòu)，沒有加新功能或者修復(fù)bug

  • perf: 優(yōu)化相關(guān)，比如提升性能、體驗(yàn)

  • test: 測試用例，包括單元測試、集成測試等

  • chore: 改變構(gòu)建流程、或者增加依賴庫、工具等

  • revert: 回滾到上一個(gè)版本

格式要求：

# 標(biāo)題行：50個(gè)字符以內(nèi)，描述主要變更內(nèi)容
#
# 主體內(nèi)容：更詳細(xì)的說明文本，建議72個(gè)字符以內(nèi)。 需要描述的信息包括:
#
# * 為什么這個(gè)變更是必須的? 它可能是用來修復(fù)一個(gè)bug，增加一個(gè)feature，提升性能、可靠性、穩(wěn)定性等等
# * 他如何解決這個(gè)問題? 具體描述解決問題的步驟
# * 是否存在副作用、風(fēng)險(xiǎn)? 
#
# 尾部：如果需要的化可以添加一個(gè)鏈接到issue地址或者其它文檔，或者關(guān)閉某個(gè)issue。

Git分支與版本發(fā)布規(guī)范

  • 基本原則：master為保護(hù)分支，不直接在master上進(jìn)行代碼修改和提交。

  • 開發(fā)日常需求或者項(xiàng)目時(shí)，從master分支上checkout一個(gè)feature分支進(jìn)行開發(fā)或者bugfix分支進(jìn)行bug修復(fù)，功能測試完畢并且項(xiàng)目發(fā)布上線后，將feature分支合并到主干master，并且打Tag發(fā)布，最后刪除開發(fā)分支。分支命名規(guī)范：

    • 分支版本命名規(guī)則：分支類型 _ 分支發(fā)布時(shí)間 _ 分支功能。比如：feature_20170401_fairy_flower

    • 分支類型包括：feature、 bugfix、refactor三種類型，即新功能開發(fā)、bug修復(fù)和代碼重構(gòu)

    • 時(shí)間使用年月日進(jìn)行命名，不足2位補(bǔ)0

    • 分支功能命名使用snake case命名法，即下劃線命名。

  • Tag包括3位版本，前綴使用v。比如v1.2.31。Tag命名規(guī)范：

    • v2.0.0-alpha-1

    • v2.0.0-belta-1

    • 新功能開發(fā)使用第2位版本號，bug修復(fù)使用第3位版本號

    • 核心基礎(chǔ)庫或者Node中間價(jià)可以在大版本發(fā)布請使用灰度版本號，在版本后面加上后綴，用中劃線分隔。alpha或者belta后面加上次數(shù)，即第幾次alpha：

  • 版本正式發(fā)布前需要生成changelog文檔，然后再發(fā)布上線。

如何接入？

接入?yún)⒖糲ommit-message-test-project項(xiàng)目。具體步驟如下：

  • 第一步：在工程跟目錄下的package.json文件加入如下代碼所示的scripts和dependencies內(nèi)容，版本號為3位版本號。

  {
    "name": "application-name",
    "version": "0.1.0",
    "scripts": {
      "commitmsg": "validate-commit-msg",
      "commit": "git-cz ",
      "changelog": "conventional-changelog -p angular -i CHANGELOG.md -s -r 0"
    },
    "devDependencies": {
      "commitizen": "^2.3.0",
      "validate-commit-msg": "^2.11.1",
      "conventional-changelog-cli": "^1.2.0",
      "husky": "^0.13.1"
    }
  }

  • 第二步：在工程根目錄新建.vcmrc文件，并且文件內(nèi)容為

{
  "helpMessage": "\nPlease fix your commit message (and consider using https://www.npmjs.com/package/commitizen)\n",
  "types": [
    "feat",
    "fix",
    "docs",
    "style",
    "refactor",
    "perf",
    "test",
    "chore",
    "revert"
  ],
  "warnOnFail": false,
  "autoFix": false
}

接入后的Git commit操作流程

  • 第一步：創(chuàng)建一個(gè)feature分支或者bugfix分支
    sh $ git checkout -b feature_infinite_load # 切換到一個(gè)feature分支或者bug fix分支 sh

  • 第二步：將代碼提交到本地Git倉庫，并填寫符合要求的Commit message格式

  $ git add .                                
  $ git commit                               # 此處不要加任何參數(shù)，比如-m

如下圖所示：

Git commit message和工作流規(guī)范的原理介紹

  • 第三步：將代碼同步到遠(yuǎn)程Git倉庫

  $ git push origin feature_infinite_load    # 將修改發(fā)布到遠(yuǎn)程倉庫

  • 第四步：自動(dòng)生成changelog，并打Tag發(fā)布

  $ tnpm run changelog                    # 使用npm script中的changlog命令直接從git元數(shù)據(jù)生成日志。
  $ git tag v0.1.0
  $ git push origin v0.1.0

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

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

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

git
AI
助
手