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