變更日誌助手
語言: English | 繁體中文
根據 Keep a Changelog 格式產生和維護 CHANGELOG.md 條目。
工作流程
- 分析 git log - 使用
git log讀取上次發布以來的提交歷史 - 分類變更 - 將提交對應到變更日誌分類
- 產生條目 - 為每個變更撰寫使用者友善的描述
- 更新 CHANGELOG.md - 將條目插入 [Unreleased] 或版本區段
變更分類
| 分類 | 使用時機 | When to Use | 對應提交類型 |
|---|---|---|---|
| Added | 新功能 | New features | feat |
| Changed | 修改既有功能 | Modifications to existing features | perf, BREAKING CHANGE |
| Deprecated | 即將移除的功能 | Features to be removed | -- |
| Removed | 已移除的功能 | Removed features | BREAKING CHANGE |
| Fixed | 錯誤修復 | Bug fixes | fix |
| Security | 安全性修補 | Security patches | security |
條目格式
## [Unreleased]
### Added
- Add user dashboard with customizable widgets (#123)
### Changed
- **BREAKING**: Change API response format from XML to JSON (#789)
### Fixed
- Fix memory leak when processing large files (#456)
撰寫指南
- 為使用者而非開發者撰寫 | Write for users, not developers
- 聚焦影響而非實作 | Focus on impact, not implementation
- 附上 issue/PR 編號 | Include issue/PR references
- 用 BREAKING 標記破壞性變更 | Mark breaking changes with BREAKING prefix
使用方式
/changelog- 分析近期提交並產生變更日誌條目- 也可透過
/release changelog [version]使用
下一步引導
/changelog 完成後，AI 助手應建議：
變更日誌已更新。建議下一步：
- 執行
/release開始發布流程- 執行
/commit提交日誌變更- 審查日誌條目確保使用者導向語言
參考
- 詳細指南：guide.md
- 核心規範：changelog-standards.md