changelog-generator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Changelog Generator

更新日志生成指南

Transform technical git commits into polished, user-friendly changelogs.

将技术化的Git提交记录转换为简洁易懂、面向用户的更新日志。

When to Use

适用场景

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
Maintaining a public changelog/product updates page

为新版本准备发布说明
制作每周或每月的产品更新摘要
为客户记录变更内容
撰写应用商店提交所需的更新日志条目
生成更新通知
维护公开的更新日志/产品更新页面

Process

操作流程

1. Scan Git History

1. 扫描Git历史记录

Analyze commits from a specific time period or between versions:

bash

undefined

分析特定时间段或版本之间的提交记录：

bash

undefined

Since last tag

从上次标签到当前版本

git log $(git describe --tags --abbrev=0)..HEAD --oneline

Between dates

按日期范围

git log --since="2024-01-01" --until="2024-01-31" --oneline

Between versions

按版本区间

git log v1.0.0..v2.0.0 --oneline

undefined

git log v1.0.0..v2.0.0 --oneline

undefined

2. Categorize Changes

2. 分类变更内容

Group commits into logical categories:

Category	Emoji	Includes
New Features	✨	New functionality, capabilities
Improvements	🔧	Enhancements, optimizations
Bug Fixes	🐛	Resolved issues, corrections
Breaking Changes	⚠️	API changes, migrations needed
Security	🔒	Security patches, vulnerability fixes
Documentation	📚	Docs updates (usually excluded)
Internal	🔨	Refactoring, tests (usually excluded)

将提交记录按逻辑分类：

分类	表情符号	包含内容
新功能	✨	新增功能、能力
优化改进	🔧	功能增强、性能优化
Bug修复	🐛	已解决问题、错误修正
破坏性变更	⚠️	API变更、需要迁移适配
安全相关	🔒	安全补丁、漏洞修复
文档更新	📚	文档修改（通常不纳入）
内部调整	🔨	代码重构、测试（通常不纳入）

3. Translate Technical → User-Friendly

3. 技术术语转用户友好表述

Bad (developer-speak):

fix: resolve null pointer in UserService#getById
refactor: extract common logic to BaseRepository

Good (user-friendly):

- Fixed an issue where user profiles wouldn't load
- Improved application performance and reliability

反面示例（开发者话术）：

fix: resolve null pointer in UserService#getById
refactor: extract common logic to BaseRepository

正面示例（用户友好表述）：

- 修复了用户资料无法加载的问题
- 提升了应用的性能和稳定性

4. Format Output

4. 格式化输出

markdown

undefined

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.

团队工作区：为不同项目创建独立工作区，邀请团队成员协作，保持内容有序管理。

🔧 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

undefined

修复了大图片无法上传的问题
解决了定时发布中的时区混乱问题

undefined

Filter Rules

过滤规则

Include:

Features (feat:, feature:)
Fixes (fix:, bugfix:)
Performance (perf:)
Security (security:)

Exclude:

Refactoring (refactor:)
Tests (test:)
CI/CD (ci:, build:)
Chores (chore:)
WIP commits

需纳入的提交类型：

功能新增（feat:, feature:）
Bug修复（fix:, bugfix:）
性能优化（perf:）
安全相关（security:）

需排除的提交类型：

代码重构（refactor:）
测试相关（test:）
CI/CD流程（ci:, build:）
日常杂务（chore:）
未完成的提交（WIP commits）

Usage Examples

使用示例

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 based on commits since v2.4.0

基于上次发布后的提交记录创建更新日志

生成过去一周所有提交记录的更新日志

基于v2.4.0以来的提交记录，为v2.5.0版本生成发布说明

Tips

小贴士

Run from your git repository root
Specify date ranges for focused changelogs
Review and adjust before publishing
Keep customer perspective - "what does this mean for them?"
Save output directly to CHANGELOG.md

在Git仓库根目录下执行命令
指定日期范围以生成聚焦的更新日志
发布前请审核并调整内容
从客户视角出发思考：「这对他们有什么影响？」
可直接将输出内容保存到CHANGELOG.md文件