changelog-generator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Changelog Generator

更新日志生成工具

This skill transforms technical git commits into polished, user-friendly changelogs that your customers and users will actually understand and appreciate.
这个技能可将技术性的Git提交转换为专业、用户友好的更新日志,让你的客户和用户能够真正理解并认可这些内容。

When to Use This Skill

适用场景

  • Preparing release notes for a new version
  • Creating weekly or monthly product update summaries
  • Documenting changes for customers
  • Writing changelog entries for app store submissions
  • Generating update notifications
  • Creating internal release documentation
  • Maintaining a public changelog/product updates page
  • 为新版本准备发布说明
  • 创建每周或每月的产品更新摘要
  • 为客户记录变更内容
  • 为应用商店提交编写更新日志条目
  • 生成更新通知
  • 创建内部发布文档
  • 维护公开的更新日志/产品更新页面

What This Skill Does

功能介绍

  1. Scans Git History: Analyzes commits from a specific time period or between versions
  2. Categorizes Changes: Groups commits into logical categories (features, improvements, bug fixes, breaking changes, security)
  3. Translates Technical → User-Friendly: Converts developer commits into customer language
  4. Formats Professionally: Creates clean, structured changelog entries
  5. Filters Noise: Excludes internal commits (refactoring, tests, etc.)
  6. Follows Best Practices: Applies changelog guidelines and your brand voice
  1. 扫描Git历史记录:分析特定时间段或版本之间的提交内容
  2. 分类变更内容:将提交内容归类为逻辑类别(新功能、改进、Bug修复、破坏性变更、安全更新)
  3. 技术语言→用户友好语言转换:将开发者的提交内容转换为客户易懂的语言
  4. 专业格式输出:创建整洁、结构化的更新日志条目
  5. 过滤无关内容:排除内部提交(如重构、测试等)
  6. 遵循最佳实践:应用更新日志编写规范和你的品牌风格

How to Use

使用方法

Basic Usage

基础用法

From your project repository:
Create a changelog from commits since last release
Generate changelog for all commits from the past week
Create release notes for version 2.5.0
在你的项目仓库中:
从上次版本发布以来的提交生成更新日志
生成过去一周所有提交的更新日志
为2.5.0版本创建发布说明

With Specific Date Range

指定日期范围

Create a changelog for all commits between March 1 and March 15
生成3月1日至3月15日之间所有提交的更新日志

With Custom Guidelines

自定义规范

Create a changelog for commits since v2.4.0, using my changelog 
guidelines from CHANGELOG_STYLE.md
根据CHANGELOG_STYLE.md中的更新日志规范,生成自v2.4.0以来的提交的更新日志

Example

示例

User: "Create a changelog for commits from the past 7 days"
Output:
markdown
undefined
用户:"生成过去7天提交的更新日志"
输出:
markdown
undefined

Updates - Week of March 10, 2024

更新内容 - 2024年3月10日当周

✨ New Features

✨ 新功能

  • Team Workspaces: Create separate workspaces for different projects. Invite team members and keep everything organized.
  • Keyboard Shortcuts: Press ? to see all available shortcuts. Navigate faster without touching your mouse.
  • 团队工作区:为不同项目创建独立的工作区。邀请团队成员,让所有内容井井有条。
  • 键盘快捷键:按?键查看所有可用快捷键。无需使用鼠标即可更快导航。

🔧 Improvements

🔧 功能改进

  • Faster Sync: Files now sync 2x faster across devices
  • Better Search: Search now includes file contents, not just titles
  • 更快的同步速度:文件在设备间的同步速度提升2倍
  • 更优的搜索功能:搜索现在包含文件内容,而不仅仅是标题

🐛 Fixes

🐛 Bug修复

  • Fixed issue where large images wouldn't upload
  • Resolved timezone confusion in scheduled posts
  • Corrected notification badge count

**Inspired by:** Manik Aggarwal's use case from Lenny's Newsletter
  • 修复了大图片无法上传的问题
  • 解决了定时发布中的时区混乱问题
  • 修正了通知徽章计数错误

**灵感来源**:Lenny通讯中Manik Aggarwal的使用案例

Tips

使用提示

  • Run from your git repository root
  • Specify date ranges for focused changelogs
  • Use your CHANGELOG_STYLE.md for consistent formatting
  • Review and adjust the generated changelog before publishing
  • Save output directly to CHANGELOG.md
  • 在Git仓库根目录运行
  • 指定日期范围以生成针对性的更新日志
  • 使用你的CHANGELOG_STYLE.md确保格式一致
  • 发布前审核并调整生成的更新日志
  • 直接将输出保存到CHANGELOG.md

Related Use Cases

相关使用场景

  • Creating GitHub release notes
  • Writing app store update descriptions
  • Generating email updates for users
  • Creating social media announcement posts
  • 创建GitHub发布说明
  • 编写应用商店更新描述
  • 生成面向用户的邮件更新
  • 创建社交媒体公告帖子