中文字幕av专区_日韩电影在线播放_精品国产精品久久一区免费式_av在线免费观看网站

溫馨提示×

溫馨提示×

您好,登錄后才能下訂單哦!

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

Git commit message和工作流規范的原理介紹

發布時間:2021-06-26 09:43:01 來源:億速云 閱讀:163 作者:chen 欄目:大數據

本篇內容介紹了“Git commit message和工作流規范的原理介紹”的有關知識,在實際案例的操作過程中,不少人都會遇到這樣的困境,接下來就讓小編帶領大家學習一下如何處理這些情況吧!希望大家仔細閱讀,能夠學有所成!

目的

  • 統一團隊Git commit日志標準,便于后續代碼review,版本發布以及日志自動化生成等等。

  • 統一團隊的Git工作流,包括分支使用、tag規范、issue等

Git commit日志參考案例

  • angular

  • commit-message-test-project

  • babel-plugin-istanbul

  • conventional-changelog

總體方案

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命名規范:

    • v2.0.0-alpha-1

    • v2.0.0-belta-1

    • 新功能開發使用第2位版本號,bug修復使用第3位版本號

    • 核心基礎庫或者Node中間價可以在大版本發布請使用灰度版本號,在版本后面加上后綴,用中劃線分隔。alpha或者belta后面加上次數,即第幾次alpha:

  • 版本正式發布前需要生成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分支
    sh $ git checkout -b feature_infinite_load # 切換到一個feature分支或者bug fix分支 sh

  • 第二步:將代碼提交到本地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 message和工作流規范的原理介紹”的內容就介紹到這里了,感謝大家的閱讀。如果想了解更多行業相關的知識可以關注億速云網站,小編將為大家輸出更多高質量的實用文章!

向AI問一下細節

免責聲明:本站發布的內容(圖片、視頻和文字)以原創、轉載和分享為主,文章觀點不代表本網站立場,如果涉及侵權請聯系站長郵箱:is@yisu.com進行舉報,并提供相關證據,一經查實,將立刻刪除涉嫌侵權內容。

git
AI

鹰潭市| 武安市| 台中市| 兰州市| 池州市| 吉林省| 禄劝| 阜新| 岳阳市| 图片| 大渡口区| 安义县| 夏邑县| 稷山县| 诸暨市| 西安市| 株洲市| 怀集县| 五寨县| 山阴县| 十堰市| 陇川县| 塔城市| 噶尔县| 资源县| 清水县| 潮安县| 海南省| 武穴市| 诏安县| 台北市| 祁东县| 广河县| 崇明县| 泾川县| 瑞昌市| 金沙县| 开原市| 安乡县| 威宁| 福州市|