iT邦幫忙

第 12 屆 iThome 鐵人賽

DAY 5
0
自我挑戰組

用 Android Studio / IntelliJ IDEA 完成 Git 操作系列 第 5

用Angular提交規範編寫提交格式

  • 分享至 

  • xImage
  •  

Angular提交規範跟GitFlow的原理類似,都是不要一團混亂的做事,假如一個提交有新功能,又有修Bug,日後要找歷史記錄會非常的困難,這篇就用我的理解來解釋Angular提交規範,有錯歡迎留言指正,謝謝

Angular提交規範原文

<type>(<scope>): <subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>
提交類型(提交範圍):空一格提交摘要 
換行  
提交內容  
換行  
提交頁尾
  • 第一行的內容
    • 提交類型,現在有九大類型,我的理解是這樣
      • build:跟第三方套件有關連
      • ci:跟CI/CD有關連
      • docs:寫文件,例如README或CHANGELOG
      • feat:新功能
      • fix:修錯誤
      • perf:程式碼最佳化的修改
      • refactor:重構
      • style:風格修改
      • test:寫測試
    • 提交範圍
      • 可寫可不寫,所以不常寫,大概是指這個提交有更改到什麼層級
    • 提交摘要
      • 使用現在式,不要大寫,也不要太長,結尾不用句號
  • 第二行的內容
    • 提交內容
      • 使用現在式,說明做了什麼,如果有結合issue系統的話,我會在這邊寫上
  • 第三行的內容
    • 提交頁尾
      • 可寫可不寫,所以不常寫,頂多是寫Close #issue編號

如果覺得每次都要手打這些很麻煩的話,Android Studio / IntelliJ IDEA有熱心使用者提供外掛
Git Commit Template

  • 下載後按Ctrl + k,開啟提交頁面
  1. 點擊紅框的按紐
  2. 輸入內容後按OK
  3. 剛剛打的內容就會出現在Commit Message裡面
    https://ithelp.ithome.com.tw/upload/images/20200905/20124384AXlZfUlexb.png

上一篇
用GitFlow分支策略建立分支
下一篇
用Android Studio / IntelliJ IDEA建立分支
系列文
用 Android Studio / IntelliJ IDEA 完成 Git 操作30
圖片
  直播研討會
圖片
{{ item.channelVendor }} {{ item.webinarstarted }} |
{{ formatDate(item.duration) }}
直播中

尚未有邦友留言

立即登入留言