Commit Message撰寫指南

基本架構

<type>: <short summary>
	<blank line>
<body>
	<blank line>
<footer>
  • <type>：Commit的類型，例如“feat”、“fix”、“docs”等。
  • <short summary>：簡短的描述，最好不超過50個字符。
  • <body>：詳細的描述，解釋為什麼進行此次更改，以及這些更改如何影響系統。
  • <footer>：可選的內容，例如引用的issue或pull請求。

Type

  1. feat：新增新功能
  2. fix：修復問題或錯誤
  3. docs：更新文檔
  4. style：調整代碼風格，例如空格、括號等
  5. refactor：重構代碼，但不是為了修復錯誤或新增功能
  6. test：新增或修改測試
  7. chore：更新代碼的構建或工具配置，例如更新依賴項、修改設置文件等

指南

  1. 使用有意義的前綴：在Commit Message中使用上述提到的前綴，以便其他人更容易理解您的代碼變更。
  2. 短小精煉的描述：在Commit Message的第一行中使用簡短的描述來概括您的代碼變更，並盡可能使用不超過50個字符。
  3. 詳細說明：在Commit Message的第二行開始提供更詳細的描述，解釋為什麼進行此次更改，以及這些更改如何影響系統。可以使用多行描述，但每行應該保持在72個字符以內。
  4. 使用動詞的現在式：在Commit Message中使用動詞的現在式，例如“修正錯誤”或“新增功能”，這有助於讓Commit Message更加明確和易於理解。
  5. 避免無意義的修改：避免無意義的Commit Message，例如“更新代碼”或“修改文件”。請確保您的Commit Message清晰明確，讓其他人容易理解您的代碼變更。
  6. 分離不同類型的修改：如果一個Commit中包含了多個不同類型的修改（例如修復bug和新增功能），請考慮將它們拆分成多個Commits，這樣可以使每個Commit更加專注並易於管理。
  7. 參考issue或請求：如果您的Commit關聯到某個issue或pull請求，請在Commit Message中引用它們，這可以幫助其他人更好地了解您的代碼變更背後的背景。

範例

範例1

feat: 新增會員註冊功能

在會員中心中新增了一個註冊功能，讓新用戶可以輕鬆創建帳戶。

Close #123

fix: 修正登入頁面樣式問題

修正了登入頁面中文本和按鈕不對齊的問題，增加了CSS樣式來修飾。

Close #456

docs: 更新API文檔

更新了API文檔，新增了對所有端點的描述，並修改了一些描述不清的部分。

未Close任何issue