keep-a-changelog-generator

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Changelog Generator

更新日志生成器

Generate changelogs from git history following Keep a Changelog format.

基于Git历史记录，按照Keep a Changelog格式生成更新日志。

When to Use

使用场景

Use this skill when you need to:

Generate changelog entries for a release
Document changes since the last version
Create release notes from commits

当你需要以下操作时使用此工具：

为版本发布生成更新日志条目
记录自上一版本以来的变更
从提交记录创建发布说明

Changelog Format

更新日志格式

Follow Keep a Changelog:

markdown

undefined

遵循Keep a Changelog:

markdown

undefined

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[Unreleased]

Added

New features

New features

Changed

Changes in existing functionality

Changes in existing functionality

Deprecated

Features that will be removed

Features that will be removed

Removed

Removed features

Removed features

Fixed

Bug fixes

Bug fixes

Security

Security fixes

undefined

Security fixes

undefined

Change Categories

变更分类

Categorize based on commit messages and code changes:

Category	Commit Keywords	Examples
Added	add, create, implement, introduce	New features, screens
Changed	update, change, modify, refactor, improve	API changes, enhancements
Deprecated	deprecate	Features to be removed
Removed	remove, delete, drop	Deleted features
Fixed	fix, resolve, correct, patch	Bug fixes
Security	security, vulnerability, CVE	Security patches

根据提交信息和代码变更进行分类：

分类	提交关键词	示例
Added	add, create, implement, introduce	新功能、新界面
Changed	update, change, modify, refactor, improve	API变更、功能增强
Deprecated	deprecate	即将移除的功能
Removed	remove, delete, drop	已删除的功能
Fixed	fix, resolve, correct, patch	漏洞修复
Security	security, vulnerability, CVE	安全补丁

Git Commands

Git命令

bash

undefined

bash

undefined

Recent commits

git log --oneline -20

Commits between tags

git log v1.0.0..HEAD --oneline

Full commit messages

git log --format="%h %s%n%b" HEAD~10..HEAD

Commits since a date

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

undefined

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

undefined

Writing Guidelines

撰写指南

User-Facing Descriptions

面向用户的描述

Translate technical commits to user benefits:

Technical: "Refactor auth state machine"
User-facing: "Improved reliability of authentication state management"

将技术提交内容转化为用户收益：

技术描述: "Refactor auth state machine"
面向用户的描述: "提升了认证状态管理的可靠性"

Breaking Changes

破坏性变更

Flag API changes clearly:

markdown

undefined

清晰标记API变更：

markdown

undefined

Changed

BREAKING:
```
login()
```
now returns
```
Promise<User>
```
instead of
```
Promise<void>
```

undefined

BREAKING:
```
login()
```
now returns
```
Promise<User>
```
instead of
```
Promise<void>
```

undefined

Output Example

输出示例

markdown

undefined

markdown

undefined

[1.2.0] - 2024-01-14

Added

New health data visualization screen
Apple HealthKit integration for step counting
Export health data to PDF

New health data visualization screen
Apple HealthKit integration for step counting
Export health data to PDF

Changed

Improved task scheduling performance
Updated questionnaire UI design

Improved task scheduling performance
Updated questionnaire UI design

Fixed

Fixed race condition in account state initialization
Resolved infinite loop when no tasks exist

undefined

Fixed race condition in account state initialization
Resolved infinite loop when no tasks exist

undefined

Workflow

工作流程

Run
```
git log
```
to get commits since last release
Group commits by category (Added/Changed/Fixed/etc.)
Identify breaking changes
Write user-facing descriptions
Include PR/issue references where available
Format following Keep a Changelog structure

运行
```
git log
```
获取自上一版本以来的提交记录
按分类（Added/Changed/Fixed等）对提交进行分组
识别破坏性变更
撰写面向用户的描述
尽可能包含PR/问题引用
按照Keep a Changelog格式进行排版