目的

  • 統(tǒng)一團隊Git commit日志標準，便于后續(xù)代碼review，版本發(fā)布以及日志自動化生成等等。

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

Git commit日志參考案例

總體方案

Android培訓,安卓培訓,手機開發(fā)培訓,移動開發(fā)培訓,云培訓培訓

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

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

對格式的說明如下：

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

  • feat： 新增feature

  • fix: 修復bug

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

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

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

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

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

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

  • revert: 回滾到上一個版本

格式要求：

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

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

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

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

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

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

    • 時間使用年月日進行命名，不足2位補0

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

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

    • v2.0.0-alpha-1

    • v2.0.0-belta-1

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

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

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

如何接入？

接入?yún)⒖?a style="margin: 0px; padding: 0px; color: rgb(0, 0, 0);">commit-message-test-project項目。具體步驟如下：

  • 第一步：在工程跟目錄下的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)建一個feature分支或者bugfix分支
    sh $ git checkout -b feature_infinite_load # 切換到一個feature分支或者bug fix分支 sh

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

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

如下圖所示：

Android培訓,安卓培訓,手機開發(fā)培訓,移動開發(fā)培訓,云培訓培訓

  • 第三步：將代碼同步到遠程Git倉庫

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

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

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

分類: 開發(fā)工具

http://www.cnblogs.com/cpselvis/p/6501485.html