叛逆修女 / RaidyHD
440 字
2 分鐘
🚩 Git紀錄習慣

1️⃣ 多數人 Git 紀錄都太隨便,無法回溯問題也不利於協作。
寫好 Git commit message 是工程師進階化的標誌,這是可讀性、可維護性與團隊溝通效率的基石。
2️⃣ 具體習慣與範本:
✅ 建議格式:<emoji> <type>: <簡短主題行(不超過 50 字)>
例如:
✨ feat: 新增文章密碼保護功能🐛 fix: 修正 og:image 無法正確讀取頭像問題📝 docs: 補上 README 使用說明🎨 style: 統一 tailwind 註解為繁體中文♻️ refactor: 抽出 layout OG metadata 重構🚀 perf: 優化圖片 lazy loading 效能✅ test: 增加 post meta parser 的單元測試🔧 chore: 調整 eslint 設定並升級套件
🧠 常見的 <type>
類型清單:
type | 用途說明 | Emoji |
---|---|---|
✨ feat | 新功能新增 | ✨ |
🐛 fix | Bug 修復 | 🐛 |
📝 docs | 文件更新、README 等 | 📝 |
🎨 style | 格式調整(不影響邏輯,如空白/註解) | 🎨 |
♻️ refactor | 重構:邏輯調整,無功能變更或修 Bug | ♻️ |
🚀 perf | 效能優化 | 🚀 |
✅ test | 測試新增或變更 | ✅ |
🔧 chore | 雜項維護(工具、設定、CI/CD 等) | 🔧 |
⏪ revert | 回復先前的 Commit | ⏪ |
🏗️ build | 編譯系統或建構工具相關變更 | 🏗️ |
⚙️ ci | CI/CD 自動化流程設定變更 | ⚙️ |
✍️ Bad vs Good 範例對比:
❌ Bad | ✅ Good |
---|---|
fix bug | 🐛 fix: 修正圖片預覽錯誤導致 build 無法通過 |
更新 | 📝 docs: 翻譯 layout 註解為繁體中文 |
add | ✨ feat: 加入 new-post 模板欄位註解功能 |
修改 css | 🎨 style: 統一 Tailwind 變數格式並補充註解 |
🛠️ 附帶建議習慣:
- 每次 Commit 只做「一件事」,避免混雜(ex: 一次改 CSS + 改 js = 拆開來)
- Commit message 第一行不超過 50 字,後面可以換行補充
- 實作大功能前用
feat: WIP XXX 功能開發中
,WIP = Work in Progress