Git commit message和工作流規範

騰訊雲加社群發表於2017-03-30
GitMIT

騰訊雲技術社群-掘金主頁持續為大家呈現雲端計算技術文章，歡迎大家關注！

作者：程柳鋒

目的

  • 統一團隊Git commit日誌標準，便於後續程式碼review，版本釋出以及日誌自動化生成等等。
  • 統一團隊的Git工作流，包括分支使用、tag規範、issue等

Git commit日誌參考案例

總體方案

Git commit message和工作流規範

Git commit日誌基本規範

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>複製程式碼

對格式的說明如下：

  • type代表某次提交的型別，比如是修復一個bug還是增加一個新的feature。所有的type型別如下：
  • feat： 新增feature
  • fix: 修復bug
  • docs: 僅僅修改了文件，比如README, CHANGELOG, CONTRIBUTE等等
  • style: 僅僅修改了空格、格式縮排、都好等等，不改變程式碼邏輯
  • refactor: 程式碼重構，沒有加新功能或者修復bug
  • perf: 優化相關，比如提升效能、體驗
  • test: 測試用例，包括單元測試、整合測試等
  • chore: 改變構建流程、或者增加依賴庫、工具等
  • revert: 回滾到上一個版本

格式要求：

# 標題行：50個字元以內，描述主要變更內容
#
# 主體內容：更詳細的說明文字，建議72個字元以內。 需要描述的資訊包括:
#
# * 為什麼這個變更是必須的? 它可能是用來修復一個bug，增加一個feature，提升效能、可靠性、穩定性等等
# * 他如何解決這個問題? 具體描述解決問題的步驟
# * 是否存在副作用、風險? 
#
# 尾部：如果需要的化可以新增一個連結到issue地址或者其它文件，或者關閉某個issue。複製程式碼

Git分支與版本釋出規範

  • 基本原則：master為保護分支，不直接在master上進行程式碼修改和提交。
  • 開發日常需求或者專案時，從master分支上checkout一個feature分支進行開發或者bugfix分支進行bug修復，功能測試完畢並且專案釋出上線後，將feature分支合併到主幹master，並且打Tag釋出，最後刪除開發分支。分支命名規範：
    • 分支版本命名規則：分支型別 分支釋出時間 分支功能。比如：feature_20170401_fairy_flower
    • 分支型別包括：feature、 bugfix、refactor三種型別，即新功能開發、bug修復和程式碼重構
    • 時間使用年月日進行命名，不足2位補0
    • 分支功能命名使用snake case命名法，即下劃線命名。
  • Tag包括3位版本，字首使用v。比如v1.2.31。Tag命名規範：
    • 新功能開發使用第2位版本號，bug修復使用第3位版本號
    • 核心基礎庫或者Node中間價可以在大版本釋出請使用灰度版本號，在版本後面加上字尾，用中劃線分隔。alpha或者belta後面加上次數，即第幾次alpha：
      • v2.0.0-alpha-1
      • v2.0.0-belta-1
  • 版本正式釋出前需要生成changelog文件，然後再發布上線。

如何接入？

接入參考commit-message-test-project專案。具體步驟如下：

  • 第一步：在工程跟目錄下的package.json檔案加入如下程式碼所示的scripts和dependencies內容，版本號為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檔案，並且檔案內容為
{
  "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操作流程

  • 第一步：建立一個feature分支或者bugfix分支

    $ git checkout -b feature_infinite_load    # 切換到一個feature分支或者bug fix分支複製程式碼

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

    $ git add .                                
$ git commit                               # 此處不要加任何引數，比如-m複製程式碼

    如下圖所示：

Git commit message和工作流規範

  • 第三步：將程式碼同步到遠端Git倉庫
    $ git push origin feature_infinite_load    # 將修改釋出到遠端倉庫複製程式碼
  • 第四步：自動生成changelog，並打Tag釋出
    $ tnpm run changelog                    # 使用npm script中的changlog命令直接從git後設資料生成日誌。
$ git tag v0.1.0
$ git push origin v0.1.0複製程式碼

相關推薦
如何寫好 Git commit messages

微信小程式深度漫遊指南

新增線下、APP、公眾號多處入口，小程式會再火起來麼？

此文已由作者授權騰訊雲技術社群釋出，轉載請註明文章出處；獲取更多雲端計算技術乾貨，可請前往騰訊雲技術社群

相關文章