[git] git commit 規範

[git] git commit 規範

  • commit log 請遵造以下格式,並注意冒號後面有一個空格
  • <type>: <subject> {必要-限制50個字元內}
  • body 和 footer 一行72個字以內
  • <body> {非必要}
  • <footer> {非必要}
  • # 範例
    # Feature: implementation login api function
    #
    # finished login module and integration with server login api
    #
    # Closes OR-xxxx
  •  <Type> 請遵守下列標籤

    • Feature: 新功能

    • Fixed: Bug修復

    • Docs: 文檔改變

    • Style: 代碼格式改變

    • Refactor: 功能重構

    • Optimized: 性能優化

    • Test: 增加測試代碼

    • Build: 改變build工具

    • CI: 與ci相關的設定

    • Added: 增加一些跟功能無關的檔案

    • 3rd: 增加第三方

  • <Subject>
    # 用來簡要描述影響本次變動,概述即可
    #
    # <Body>
    # 具體的修改訊息,越詳細越好
    #
    # <Footer>
    # 如果是要關閉特定 Issue 或 Bug. 可以使用 Closes PROJECT-1 or Resolves PROJECT-1 or Fixes PROJECT-1
    # 具體參考 https://docs.gitlab.com/ee/user/project/integrations/jira.html