changelog-maintenance

Compare original and translation side by side

🇺🇸

Original

English

🇨🇳

Translation

Chinese

Changelog Maintenance

变更日志维护

When to use this skill

何时使用此方法

릴리스 전: 버전 출시 전 변경사항 정리
지속적: 주요 변경 발생 시마다 업데이트
마이그레이션 가이드: Breaking changes 문서화

发布前：整理版本发布前的变更内容
持续维护：每当发生重要变更时进行更新
迁移指南：记录破坏性变更（Breaking changes）

Instructions

操作步骤

Step 1: Keep a Changelog 형식

步骤1：遵循Keep a Changelog格式

CHANGELOG.md:

markdown

undefined

CHANGELOG.md:

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 user profile customization options
Dark mode support

New user profile customization options
Dark mode support

Changed

Improved performance of search feature

Improved performance of search feature

Fixed

Bug in password reset email

Bug in password reset email

[1.2.0] - 2025-01-15

Added

Two-factor authentication (2FA)
Export user data feature (GDPR compliance)
API rate limiting
Webhook support for order events

Two-factor authentication (2FA)
Export user data feature (GDPR compliance)
API rate limiting
Webhook support for order events

Changed

Updated UI design for dashboard
Improved email templates
Database query optimization (40% faster)

Updated UI design for dashboard
Improved email templates
Database query optimization (40% faster)

Deprecated

```
GET /api/v1/users/list
```
(use
```
GET /api/v2/users
```
instead)

```
GET /api/v1/users/list
```
(use
```
GET /api/v2/users
```
instead)

Removed

Legacy authentication method (Basic Auth)

Legacy authentication method (Basic Auth)

Fixed

Memory leak in background job processor
CORS issue with Safari browser
Timezone bug in date picker

Memory leak in background job processor
CORS issue with Safari browser
Timezone bug in date picker

Security

Updated dependencies (fixes CVE-2024-12345)
Implemented CSRF protection
Added helmet.js security headers

Updated dependencies (fixes CVE-2024-12345)
Implemented CSRF protection
Added helmet.js security headers

[1.1.2] - 2025-01-08

Fixed

Critical bug in payment processing
Session timeout issue

Critical bug in payment processing
Session timeout issue

[1.1.0] - 2024-12-20

Added

User profile pictures
Email notifications
Search functionality

User profile pictures
Email notifications
Search functionality

Changed

Redesigned login page
Improved mobile responsiveness

Redesigned login page
Improved mobile responsiveness

[1.0.0] - 2024-12-01

Initial release

Added

User registration and authentication
Basic profile management
Product catalog
Shopping cart
Order management

undefined

User registration and authentication
Basic profile management
Product catalog
Shopping cart
Order management

undefined

Step 2: Semantic Versioning

步骤2：语义化版本控制（Semantic Versioning）

버전 번호:

MAJOR.MINOR.PATCH

Given a version number MAJOR.MINOR.PATCH, increment:

MAJOR (1.0.0 → 2.0.0): Breaking changes
  - API 변경으로 기존 코드가 동작하지 않음
  - 예: 필수 파라미터 추가, 응답 구조 변경

MINOR (1.1.0 → 1.2.0): Backward-compatible features
  - 새로운 기능 추가
  - 기존 기능은 그대로 동작
  - 예: 새 API 엔드포인트, optional 파라미터

PATCH (1.1.1 → 1.1.2): Backward-compatible bug fixes
  - 버그 수정
  - 보안 패치
  - 예: 메모리 누수 수정, 타이포 수정

예시:

```
1.0.0
```
→
```
1.0.1
```
: 버그 수정
```
1.0.1
```
→
```
1.1.0
```
: 새 기능 추가
```
1.1.0
```
→
```
2.0.0
```
: Breaking change

版本号：

MAJOR.MINOR.PATCH

给定版本号 MAJOR.MINOR.PATCH，递增规则如下：

MAJOR（1.0.0 → 2.0.0）：破坏性变更
  - API变更导致原有代码无法正常运行
  - 示例：新增必填参数、修改响应结构

MINOR（1.1.0 → 1.2.0）：向后兼容的功能更新
  - 添加新功能
  - 原有功能保持正常运行
  - 示例：新增API端点、可选参数

PATCH（1.1.1 → 1.1.2）：向后兼容的Bug修复
  - 修复Bug
  - 安全补丁
  - 示例：修复内存泄漏、修正拼写错误

示例:

```
1.0.0
```
→
```
1.0.1
```
：Bug修复
```
1.0.1
```
→
```
1.1.0
```
：新增功能
```
1.1.0
```
→
```
2.0.0
```
：破坏性变更

Step 3: Release Notes (사용자 친화적)

步骤3：用户友好型发布说明（Release Notes）

markdown

undefined

markdown

undefined

Release Notes v1.2.0

Released: January 15, 2025

🎉 What's New

🎉 新功能

Two-Factor Authentication

双因素认证（Two-Factor Authentication）

You can now enable 2FA for enhanced security. Go to Settings > Security to set it up.

现在你可以启用2FA以增强账户安全性。前往设置 > 安全页面进行配置。

Export Your Data

数据导出功能

We've added the ability to export all your data in JSON format. Perfect for backing up or migrating your account.

我们新增了将所有数据导出为JSON格式的功能，非常适合账户备份或迁移。

✨ Improvements

✨ 优化改进

Faster Search: Search is now 40% faster thanks to database optimizations
Better Emails: Redesigned email templates for a cleaner look
Dashboard Refresh: Updated UI with modern design

更快的搜索：得益于数据库优化，搜索速度提升40%
更美观的邮件：重新设计了邮件模板，界面更简洁
仪表盘更新：采用现代设计更新了仪表盘UI

🐛 Bug Fixes

🐛 Bug修复

Fixed a bug where password reset emails weren't being sent
Resolved timezone issues in the date picker
Fixed memory leak in background jobs

修复了密码重置邮件无法发送的问题
解决了日期选择器中的时区问题
修复了后台任务处理器中的内存泄漏

⚠️ Breaking Changes

⚠️ 破坏性变更

If you're using our API:

Removed: Basic Authentication is no longer supported
- Migration: Use JWT tokens instead (see Auth Guide)
Deprecated:
```
GET /api/v1/users/list
```
- Migration: Use
```
GET /api/v2/users
```
  with pagination

如果你正在使用我们的API：

已移除：不再支持基础认证（Basic Authentication）
- 迁移方案：改用JWT令牌（详见认证指南）
已废弃：
```
GET /api/v1/users/list
```
- 迁移方案：使用带分页功能的
```
GET /api/v2/users
```

🔒 Security

🔒 安全更新

Updated all dependencies to latest versions
Added CSRF protection to all forms
Implemented security headers with helmet.js

将所有依赖更新至最新版本
为所有表单添加了CSRF防护
通过helmet.js实现了安全头配置

📝 Full Changelog

📝 完整变更日志

See CHANGELOG.md for complete details.

Upgrade Instructions: docs/upgrade-to-v1.2.md

undefined

详情请查看CHANGELOG.md。

升级说明：docs/upgrade-to-v1.2.md

undefined

Step 4: Breaking Changes 마이그레이션 가이드

步骤4：破坏性变更迁移指南

markdown

undefined

markdown

undefined

Migration Guide: v1.x to v2.0

迁移指南：v1.x 至 v2.0

Breaking Changes

破坏性变更

1. Authentication Method Changed

1. 认证方式变更

Before (v1.x): ```javascript fetch('/api/users', { headers: { 'Authorization': 'Basic ' + btoa(username + ':' + password) } }); ```

After (v2.0): ```javascript // 1. Get JWT token const { accessToken } = await fetch('/api/auth/login', { method: 'POST', body: JSON.stringify({ email, password }) }).then(r => r.json());

// 2. Use token fetch('/api/users', { headers: { 'Authorization': 'Bearer ' + accessToken } }); ```

旧版本（v1.x）: ```javascript fetch('/api/users', { headers: { 'Authorization': 'Basic ' + btoa(username + ':' + password) } }); ```

新版本（v2.0）: ```javascript // 1. 获取JWT令牌 const { accessToken } = await fetch('/api/auth/login', { method: 'POST', body: JSON.stringify({ email, password }) }).then(r => r.json());

// 2. 使用令牌 fetch('/api/users', { headers: { 'Authorization': 'Bearer ' + accessToken } }); ```

2. User List API Response Format

2. 用户列表API响应格式变更

Before (v1.x): ```json { "users": [...] } ```

After (v2.0): ```json { "data": [...], "pagination": { "page": 1, "limit": 20, "total": 100 } } ```

Migration: ```javascript // v1.x const users = response.users;

// v2.0 const users = response.data; ```

旧版本（v1.x）: ```json { "users": [...] } ```

新版本（v2.0）: ```json { "data": [...], "pagination": { "page": 1, "limit": 20, "total": 100 } } ```

迁移代码示例: ```javascript // v1.x const users = response.users;

// v2.0 const users = response.data; ```

Deprecation Timeline

废弃时间线

v2.0 (Jan 2025): Basic Auth marked as deprecated
v2.1 (Feb 2025): Warning logs for Basic Auth usage
v2.2 (Mar 2025): Basic Auth removed

undefined

v2.0（2025年1月）：标记基础认证为废弃
v2.1（2025年2月）：使用基础认证时输出警告日志
v2.2（2025年3月）：彻底移除基础认证

undefined

Output format

输出格式

CHANGELOG.md             # 개발자용 상세 로그
RELEASES.md              # 사용자용 릴리스 노트
docs/migration/
  ├── v1-to-v2.md        # 마이그레이션 가이드
  └── v2-to-v3.md

CHANGELOG.md             # 面向开发者的详细变更日志
RELEASES.md              # 面向用户的发布说明
docs/migration/
  ├── v1-to-v2.md        # v1到v2的迁移指南
  └── v2-to-v3.md

Constraints

约束规则

필수 규칙 (MUST)

必须遵守的规则（MUST）

역순 정렬: 최신 버전이 위에
날짜 포함: ISO 8601 형식 (YYYY-MM-DD)
카테고리 분류: Added, Changed, Fixed, etc.

倒序排列：最新版本放在最上方
包含日期：采用ISO 8601格式（YYYY-MM-DD）
分类整理：按照Added、Changed、Fixed等类别划分

금지 사항 (MUST NOT)

禁止事项（MUST NOT）

Git Log 복사 금지: 사용자 관점으로 작성
모호한 표현: "버그 수정", "성능 개선" (구체적으로)

禁止直接复制Git日志：从用户视角进行编写
禁止模糊表述：避免使用“修复Bug”、“性能优化”等笼统描述，需具体说明