Git Commit 撰寫

• figma 圖解說明版

認識 Commit 結構

一個好的 commit 能夠說明 what 和 why，幫助共同維護程式碼的人理解這個變更的內容 (what)，與為什麼要變更 (why)，詳細可閱讀 Git Commit Message 這樣寫會更好，替專案引入規範與範例

commit 結構有以下三個區塊:

• Header: 說明做了什麼變更、變更屬於哪個類型
• Body: 補充詳細的變更內容與為什麼變更
• Footer: 註記相關的 issue (如果有，目前不採用)

Header 怎麼寫

格式: 變更類型 - 變更範圍 (變更說明)

• 變更類型: commit 的分類
  • 如: 切版、串接資料、fix、feat、refactor、style、test
• 變更範圍: 變更影響的範圍
  • 如: 功能名稱、頁面名稱
• 變更說明: 簡短說明變更了什麼，字數不超過 50 字元
  • 如: 修改表單驗證邏輯

Body 怎麼寫

格式: 分區標題 & 條列式說明，每行不超過 72 字元

• 分區標題
  • 如: 調整項目、問題、原因、與修改前比較
• 條列式說明
  • 如:

調整項目:
- 修改資料排序: 原是依照建立順序，改為依照狀態排序，狀態為啟用中往前排
- 表格空欄顯示為 "--"

不同工具的撰寫方式

在 VS Code Git 頁籤 (Source Control)

在 同一個輸入框內輸入多行文字，以「空行」分隔 header 和 body：

feat: 新增登入頁面

- 加入 email、password 欄位
- 補上 basic 驗證

這樣 VS Code 在 commit 時會正確地將第一行當作 header，後面當作 body。

在 Command line