name: 变更日志生成器 description: 通过分析提交历史、分类变更并将技术提交转化为清晰、客户友好的发布说明,自动从Git提交创建面向用户的变更日志。将数小时的手动变更日志编写转化为数分钟的自动生成。
变更日志生成器
此技能将技术性的Git提交转化为精美、用户友好的变更日志,让您的客户和用户能够真正理解和欣赏。
何时使用此技能
- 为新版本准备发布说明
- 创建每周或每月的产品更新摘要
- 为客户记录变更
- 为应用商店提交编写变更日志条目
- 生成更新通知
- 创建内部发布文档
- 维护公共变更日志/产品更新页面
此技能的功能
- 扫描Git历史:分析特定时间段或版本之间的提交
- 分类变更:将提交分组为逻辑类别(新功能、改进、错误修复、破坏性变更、安全)
- 技术 → 用户友好翻译:将开发者提交转化为客户语言
- 专业格式化:创建干净、结构化的变更日志条目
- 过滤噪音:排除内部提交(重构、测试等)
- 遵循最佳实践:应用变更日志指南和您的品牌声音
如何使用
基本用法
从您的项目仓库:
创建自上次发布以来的提交变更日志
生成过去一周所有提交的变更日志
为版本2.5.0创建发布说明
指定日期范围
创建3月1日至3月15日所有提交的变更日志
使用自定义指南
创建自v2.4.0以来的提交变更日志,使用我的变更日志指南从CHANGELOG_STYLE.md
示例
用户:“创建过去7天提交的变更日志”
输出:
# 更新 - 2024年3月10日当周
## ✨ 新功能
- **团队工作空间**:为不同项目创建单独的工作空间。邀请团队成员,保持一切井井有条。
- **键盘快捷键**:按?查看所有可用快捷键。无需触摸鼠标即可更快导航。
## 🔧 改进
- **更快同步**:文件现在在设备间同步速度提高2倍
- **更好搜索**:搜索现在包括文件内容,不仅是标题
## 🐛 修复
- 修复了大型图像无法上传的问题
- 解决了预定帖子中的时区混乱
- 更正了通知徽章计数
灵感来源:Manik Aggarwal在Lenny’s Newsletter中的使用案例
提示
- 从您的Git仓库根目录运行
- 指定日期范围以聚焦变更日志
- 使用您的CHANGELOG_STYLE.md以保持格式一致
- 在发布前审查并调整生成的变更日志
- 直接将输出保存到CHANGELOG.md
相关使用案例
- 创建GitHub发布说明
- 编写应用商店更新描述
- 为用户生成电子邮件更新
- 创建社交媒体公告帖子