工作流程
- 檢查儲存庫狀態:
git status --short、git diff --cached 和 git diff。同時檢查 git log --oneline -10 以符合現有風格。
- 如果沒有暫存的變更,請透過明確的路徑暫存相關變更(避免使用
git add -A,以避免包含無關或敏感的檔案)。絕對不要暫存 .env、密鑰或 .venv。
- 如果變更涉及明顯無關的關注點,請將它們拆分為單獨的提交。
- 按照以下格式編寫訊息,然後使用
git commit 提交。
- 執行
git status 以確認提交成功。
- 僅當使用者傳遞
--push 時才推送:執行 git push(若未設定上游,請使用 git push -u origin <branch>)。絕不強制推送。
訊息格式
<類型>(<選用範圍>): <描述>
<選用內文>
<選用結尾>
- 類型:
feat、fix、docs、style、refactor、perf、test、build、ci、chore、revert。
- 描述:祈使語氣、小寫、結尾不加句號、最多約72個字元。
- 範圍:受影響區域的簡短名詞(例如
cli、server、translate);如果不清楚,請省略。
- 內文:解釋為何要這麼做,每行約72個字元;對於微不足道的變更,可省略。
- 中斷變更:在類型/範圍後加上
!,並在結尾加上 BREAKING CHANGE:。
規則
- 除非被要求,否則不要修改、重寫或重寫歷史記錄。
- 不要跳過掛鉤(
--no-verify)。
- 如果掛鉤失敗,請修復問題並建立新的提交。
- 如果沒有變更,請不要提交;而是告知使用者。