Back to Details

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.
本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

Instructions

使用说明

When creating a changelog:
  1. Analyze Git History
    • Use 
      git log
      to retrieve commit messages for the specified time period
    • Default to commits since the last tag if no range specified
    • Look for commit conventions (Conventional Commits, semantic versioning tags)
  2. Categorize Commits
    • ✨ New Features: New capabilities or functionality
    • 🔧 Improvements: Enhancements to existing features
    • 🐛 Bug Fixes: Corrections to defects
    • ⚠️ Breaking Changes: Changes that require user action
    • 🔒 Security: Security-related fixes or improvements
    • 📚 Documentation: Documentation updates (usually exclude from user-facing changelog)
    • 🧹 Internal: Refactoring, tests, build changes (exclude from user-facing changelog)
  3. Transform Technical → User Language
    • Focus on what changed for the user, not how it was implemented
    • Use active voice and present tense
    • Explain the benefit, not the implementation
    • Replace technical jargon with plain language
    Examples:
    • ❌ "Refactored authentication service to use JWT tokens"
    • ✅ "Faster, more secure login experience"
    • ❌ "Added Redis caching layer to API endpoints"
    • ✅ "Pages load 50% faster"
    • ❌ "Implemented debounce on search input component"
    • ✅ "Search now responds instantly as you type"
  4. Format the Changelog
    • Use clear section headers with emojis for visual scanning
    • Start with most impactful changes (features, breaking changes)
    • Use bold for the feature name, then explain in plain language
    • Keep entries concise (1-2 sentences)
    • Group related changes together
  5. Apply Filters
    • Exclude commits marked as 
      chore:
      , 
      test:
      , 
      docs:
      , 
      refactor:
      (unless user-facing)
    • Skip merge commits and version bump commits
    • Combine multiple commits about the same feature into one entry
    • Remove developer-only changes
  6. Add Context
    • Include the date or version number in the title
    • Add a brief introduction if it's a major release
    • Link to detailed documentation for breaking changes
    • Include migration guides when relevant
创建更新日志时：
  1. 分析Git历史
    • 使用
      git log
      获取指定时间段的提交信息
    • 若未指定范围，默认获取上一个标签之后的所有提交
    • 识别提交规范（Conventional Commits、语义化版本标签）
  2. 提交分类
    • ✨ 新功能：新增的能力或功能
    • 🔧 优化：对现有功能的增强
    • 🐛 Bug修复：缺陷修正
    • ⚠️ 破坏性变更：需要用户采取对应操作的变更
    • 🔒 安全：与安全相关的修复或优化
    • 📚 文档：文档更新（通常不对外展示在面向用户的更新日志中）
    • 🧹 内部：重构、测试、构建变更（不对外展示在面向用户的更新日志中）
  3. 技术语言转用户语言
    • 重点关注对用户产生了什么变化，而非实现方式
    • 使用主动语态和现在时态
    • 说明收益，而非实现细节
    • 用通俗易懂的语言替换技术术语
    示例：
    • ❌ "重构认证服务以使用JWT令牌"
    • ✅ "登录体验更快、更安全"
    • ❌ "为API接口添加Redis缓存层"
    • ✅ "页面加载速度提升50%"
    • ❌ "为搜索输入组件实现防抖功能"
    • ✅ "搜索现在可随输入即时响应"
  4. 格式化更新日志
    • 使用带emoji的清晰章节标题，方便快速浏览
    • 优先展示影响最大的变更（新功能、破坏性变更）
    • 功能名称使用粗体，之后用通俗易懂的语言说明
    • 条目保持简洁（1-2句话）
    • 相关变更归为一组
  5. 应用过滤规则
    • 排除标记为
      chore:
      、
      test:
      、
      docs:
      、
      refactor:
      的提交（除非对用户可见）
    • 跳过合并提交和版本号升级提交
    • 将同一个功能的多个提交合并为一个条目
    • 移除仅对开发者可见的变更
  6. 补充上下文
    • 标题中包含日期或版本号
    • 若是重大版本更新，添加简短介绍
    • 为破坏性变更添加详细文档的链接
    • 相关情况下提供迁移指南

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

🐛 修复

  • 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的用例

Changelog Best Practices

更新日志最佳实践

Writing Style

写作风格

  • User-focused: Explain what changed for the user, not the code
  • Benefit-oriented: Lead with why this matters
  • Concise: Keep entries to 1-2 sentences
  • Scannable: Use formatting to help users find what they care about
  • 以用户为中心：说明对用户产生了什么变化，而非代码变动
  • 以收益为导向：优先说明变更的价值
  • 简洁：条目保持1-2句话
  • 易浏览：使用格式帮助用户快速找到关心的内容

Structure

结构

  • Consistent categorization: Use the same categories every time
  • Most important first: Features and breaking changes before bug fixes
  • Chronological within categories: Newest changes first
  • Visual hierarchy: Use headers, bold text, and emojis effectively
  • 分类一致：每次都使用相同的分类规则
  • 优先级排序：新功能和破坏性变更放在Bug修复之前
  • 分类内按时间排序：最新的变更放在最前面
  • 视觉层级：合理使用标题、粗体和emoji

Content Guidelines

内容规范

  • Be specific: "Fixed login issues" → "Fixed issue where login failed with Google accounts"
  • Quantify when possible: "Faster loading" → "Pages load 50% faster"
  • Include context: Explain why changes were made for major updates
  • Link to details: Reference documentation or migration guides for complex changes
  • 具体明确："修复了登录问题" → "修复了使用Google账号登录失败的问题"
  • 尽可能量化："加载速度更快" → "页面加载速度提升50%"
  • 包含上下文：说明重大更新的变更原因
  • 添加详情链接：为复杂变更关联参考文档或迁移指南

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发布说明
  • 撰写应用商店更新描述
  • 生成面向用户的邮件更新内容
  • 创建社交媒体公告帖子

Example Transformations

转换示例

Technical Commit → User-Friendly Entry

技术提交 → 用户友好条目

Technical CommitUser-Friendly Entry
"Add OAuth2 support for SSO integration""Single Sign-On: Log in with your company account"
"Optimize database queries with indexes""Dashboard loads 3x faster"
"Implement WebSocket connection for real-time updates""See changes instantly without refreshing"
"Add validation for email input fields""Helpful error messages when entering invalid emails"
"Fix memory leak in background sync worker""Improved app stability during long sessions"
技术提交用户友好条目
"Add OAuth2 support for SSO integration""单点登录：使用你的公司账号即可登录"
"Optimize database queries with indexes""看板加载速度提升3倍"
"Implement WebSocket connection for real-time updates""无需刷新即可即时查看变更"
"Add validation for email input fields""输入无效邮箱时会展示友好的错误提示"
"Fix memory leak in background sync worker""长时间使用时的应用稳定性提升"

Category Examples

分类示例

✨ New Features
  • New capabilities that didn't exist before
  • Major additions to functionality
  • New integrations or platform support
🔧 Improvements
  • Performance enhancements
  • UI/UX refinements
  • Expanded existing functionality
  • Better error messages
🐛 Bug Fixes
  • Corrections to existing features
  • Resolution of reported issues
  • Fixes to edge cases
⚠️ Breaking Changes
  • Changes requiring user action
  • Removed features or APIs
  • Changes to default behavior
  • Migration steps required
🔒 Security
  • Security patches
  • Permission improvements
  • Authentication enhancements
  • Data protection updates
✨ 新功能
  • 此前不存在的全新能力
  • 重大功能新增
  • 新的集成或平台支持
🔧 优化
  • 性能提升
  • UI/UX改进
  • 现有功能扩展
  • 更完善的错误提示
🐛 Bug修复
  • 现有功能的问题修正
  • 已反馈问题的解决
  • 边缘场景问题修复
⚠️ 破坏性变更
  • 需要用户采取操作的变更
  • 移除的功能或API
  • 默认行为变更
  • 需要执行迁移步骤
🔒 安全
  • 安全补丁
  • 权限优化
  • 认证能力增强
  • 数据保护更新