Git 日誌提交規範

Commit messages的基本語法

當前業界應用的比較廣泛的是 Angular Git Commit Guidelines
具體格式為:

<type>: <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
  • type: 本次 commit 的類型,諸如 bugfix docs style 等
  • scope: 本次 commit 波及的範圍
  • subject: 簡明扼要的闡述下本次 commit 的主旨,在原文中特意強調了幾點 1. 使用祈使句,是不是很熟悉又陌生的一個詞,來傳送門在此 祈使句 2. 首字母不要大寫 3. 結尾無需添加標點
  • body: 同樣使用祈使句,在主體內容中我們需要把本次 commit 詳細的描述一下,比如此次變更的動機,如需換行,則使用 |
  • footer: 描述下與之關聯的 issue 或 break change,詳見案例

Type的類別說明:

  • feat: 添加新特性
  • fix: 修復bug
  • docs: 僅僅修改了文檔
  • style: 僅僅修改了空格、格式縮進、都好等等,不改變程式碼邏輯
  • refactor: 程式碼重構,沒有加新功能或者修復bug
  • perf: 增加程式碼進行性能測試
  • test: 增加測試用例
  • chore: 改變構建流程、或者增加依賴庫、工具等

Commit messages格式要求

# 標題行:50個字元以內,描述主要變更內容
#
# 主體內容:更詳細的說明文本,建議72個字元以內。 需要描述的資訊包括:
#
# * 為什麼這個變更是必須的? 它可能是用來修復一個bug,增加一個feature,提升性能、可靠性、穩定性等等
# * 他如何解決這個問題? 具體描述解決問題的步驟
# * 是否存在副作用、風險? 
#
# 如果需要的化可以添加一個鏈接到issue地址或者其它文檔

參考鏈接
您必須知道的 Git 分支開發規範