Back to Details

release-notes-composer

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese

Changelog Generator

Changelog 生成工具

This skill transforms technical git commits into polished, user-friendly changelogs that your customers and users will actually understand and appreciate.
该Skill可将技术化的Git提交内容转化为专业易懂、用户友好的变更日志，让你的客户与用户能够轻松理解并认可。

When to Use This Skill

何时使用该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

该Skill的功能

  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
在项目仓库根目录下使用：
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

With Specific Date Range

指定日期范围

Create a changelog for all commits between March 1 and March 15
Create a changelog for all commits between March 1 and March 15

With Custom Guidelines

自定义规范

Create a changelog for commits since v2.4.0, using my changelog 
guidelines from CHANGELOG_STYLE.md
Create a changelog for commits since v2.4.0, using my changelog 
guidelines from CHANGELOG_STYLE.md

Example

示例

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

Updates - Week of March 10, 2024

Updates - Week of March 10, 2024

✨ New Features

✨ 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.
  • 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

🔧 Improvements

  • Faster Sync: Files now sync 2x faster across devices
  • Better Search: Search now includes file contents, not just titles
  • Faster Sync: Files now sync 2x faster across devices
  • Better Search: Search now includes file contents, not just titles

🐛 Fixes

🐛 Fixes

  • 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
  • Fixed issue where large images wouldn't upload
  • Resolved timezone confusion in scheduled posts
  • Corrected notification badge count

**灵感来源**：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发布说明
  • 撰写应用商店更新描述
  • 为用户生成邮件更新通知
  • 制作社交媒体公告帖