天天看點

優雅的Git Commit Message

 源起

不知道大家看到那些非常随意的送出資訊會有什麼感受,這裡可以上一個圖給大家感受一下。會不會覺得太過于潇灑和随便了。完全看不出做了哪些變更,在項目正常運作時還好,一旦需要復原,就很難尋找版本了。

優雅的Git Commit Message

 是以,不管是團隊開發還是個人開發,遵循統一合理的送出規範是很有必要的,畢竟沒有人能記得住一年前的代碼吧。

Git Commit Message規範

<type>(<scope>): <subject>

下面分别介紹這幾個參數的具體含義和規範

<type>

 用于表示commit的類型,必寫。(以下類型大部分來自Angular團隊規範)

  • feat:新功能
  • fix:bug修複
  • refactor:代碼重構
  • docs:文檔修改(不影響具體功能)
  • style:樣式修改(不影響具體功能)
  • test:測試内容的修改或增加
  • chore:建構流程或依賴管理的變更
  • perf:代碼優化:性能提升,安全問題,錯誤捕捉等
  • revert:代碼版本復原

 <scope>

用于表示commit的影響範圍,可以用route, component, utils, build等,也可以使用具體的子產品名稱或路徑、檔案夾等來填充

<subject>

作為commit的簡單介紹,如果有多個功能點或者修改點最好可以用序号辨別,簡潔明了為主要目标,一般不超過50個字。

總結

個人認為這種統一友好的格式規範很有必要,我相信好的習慣總會有好的地方。