代碼規範 - Git使用規範

目的

爲了規範代碼庫使用、分支管理和版本管理，使代碼分支及版本結構清晰，方便維護，並避免因爲維護形成的錯誤的版本發佈等問題。

適用範圍

適用於全部開發。

內容

提交代碼說明規範

• [+]增長的需求
• [-]刪減的需求
• [*]優化的需求
• [!]修復bug的需求

Code Review

• 除我的分支外，都設置爲 protected
• 提交代碼必須經過頁面的 Merge Requests

提交代碼頻率規範

• 天天至少提交一次，提交前必須 merge 對應分支
• 建議每週至少merge一次master
• 養成完成需求隨時提交的習慣

代碼開發發佈規範

• 迭代開始從master新建版本分支

  • 開發人員今後分支拉出我的分支進行開發
• 測試環境代碼爲版本迭代分支

• 發佈

  • merge master最新代碼
  • 自測
  • 合併到預發佈分支進行測試
  • 合併到master分支發佈代碼
  • 生成版本號 TAG
  • 刪除開發分支

GIT 分支管理

• 一般每一個項目的代碼將包括

  • master：主分支，必定等於生產環境中部署的代碼
  • staging: 預發佈分支
  • feature：開發分支，用於測試，每一個人開發今後分支拉取我的分支進行開發
  • fix：修復分支
  • user: 我的開發分支
  • TAG：每次發佈後都生成對應的版本號TAG

• 分支的命名規則分別

  • feature-{v}-{info}-{date}: feature-0.0.1-test-20180801
  • fix-{v}-{info}-{date}: fix-0.0.1-test-20180801

  • user-{name}-{v}-{info}-{date}: user-xxx-0.0.1-test-20180801

    • v：版本號
    • info：特性
    • date：建立日期
• 當上線成功後 刪除分支