变更日志助手
语言: 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