Git commit message和工做流規範

時間 2019-12-09

標籤 git commit message 規範欄目 Git 简体版

原文原文鏈接

目的

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

Git commit日誌參考案例

整體方案

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: 回滾到上一個版本

格式要求：git

# 標題行：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項目。具體步驟以下：github

第一步：在工程跟目錄下的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分支
sh $ git checkout -b feature_infinite_load # 切換到一個feature分支或者bug fix分支 shnpm
第二步：將代碼提交到本地Git倉庫，並填寫符合要求的Commit message格式

$ git add .                                
  $ git commit                               # 此處不要加任何參數，好比-m

以下圖所示：json

第三步：將代碼同步到遠程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

開源信息

騰訊NOW直播前端工程化解決方案feflow正式開源啦~： https://github.com/cpselvis/feflow-cli

相關標籤/搜索

每日一句

每一个你不满意的现在，都有一个你没有努力的曾经。