Commit Message 助手
語言: English | 繁體中文
根據 staged 的變更,產生符合 Conventional Commits 格式的 commit message。
工作流程
- 檢查狀態 - 執行
git status和git diff --staged了解變更內容 - 分析變更 - 判斷類型(feat、fix、refactor 等)和範圍
- 產生訊息 - 根據以下格式建立 commit message
- 確認並提交 - 在執行
git commit前詢問使用者確認
訊息格式
<type>(<scope>): <subject>
<body>
<footer>
提交類型
| 類型 | 使用時機 | When to Use |
|---|---|---|
feat |
新功能 | New feature |
fix |
修復錯誤 | Bug fix |
refactor |
重構(無功能變更) | Code refactoring |
docs |
文件更新 | Documentation |
style |
格式調整(無邏輯變更) | Formatting |
test |
測試相關 | Tests |
perf |
效能優化 | Performance |
chore |
維護任務 | Maintenance |
規則
- Subject:祈使語氣、不加句號、首字母大寫、不超過 72 字元
- Body:說明為什麼進行變更,而非僅描述變更了什麼
- Footer:使用
BREAKING CHANGE:標記破壞性變更,使用Fixes #123關聯 issue
使用方式
/commit- 自動分析 staged 的變更並建議 commit message/commit fix login bug- 根據提供的描述產生訊息
下一步引導
/commit 完成後,AI 助手應建議:
提交完成。建議下一步:
- 執行
git push推送到遠端- 準備發布時 → 執行
/changelog+/release- 發現重複模式或規範摩擦 → 執行
/audit --report回報
參考
- 詳細指南:guide.md
- 核心規範:commit-message-guide.md