Back to Details

release-notes-generator

Compare original and translation side by side

🇺🇸

Original

English
🇨🇳

Translation

Chinese
<!-- This source file is part of the Stanford Spezi open-source project. SPDX-FileCopyrightText: 2026 Stanford University and the project authors (see CONTRIBUTORS.md) SPDX-License-Identifier: MIT -->
<!-- This source file is part of the Stanford Spezi open-source project. SPDX-FileCopyrightText: 2026 Stanford University and the project authors (see CONTRIBUTORS.md) SPDX-License-Identifier: MIT -->

Release Notes Generator

版本说明生成器

Create release notes summarizing features, fixes, and breaking changes for releases.
创建版本说明，汇总版本发布的新功能、修复内容及破坏性变更。

When to Use

适用场景

Use this skill when you need to:
  • Prepare release notes for a new version
  • Summarize changes for users/stakeholders
  • Document migration steps for breaking changes
在以下场景中使用本技能：
  • 为新版本准备版本说明
  • 为用户/利益相关者汇总变更内容
  • 记录破坏性变更的迁移步骤

Release Notes Structure

版本说明结构

markdown
undefined
markdown
undefined

Release v1.2.0

Release v1.2.0

Highlights

重点摘要

Brief summary of the most important changes (2-3 sentences).
简要概述最重要的变更（2-3句话）。

New Features

新功能

Feature Name

功能名称

Description of what it does and why it matters.
Usage:
typescript
// Code example
描述功能作用及重要性。
使用示例：
typescript
// Code example

Improvements

优化改进

  • Improvement 1
  • Improvement 2
  • 优化点1
  • 优化点2

Bug Fixes

问题修复

  • Fixed issue with X (#123)
  • Resolved Y when Z
  • 修复了X相关问题（#123）
  • 解决了Z场景下的Y问题

Breaking Changes

破坏性变更

Change Name

变更名称

What changed: Description
Migration:
typescript
// Before
oldMethod();

// After
newMethod();
变更内容： 描述
迁移指南：
typescript
// Before
oldMethod();

// After
newMethod();

Dependencies

依赖更新

  • Updated 
    package-name
    from 1.0.0 to 2.0.0
undefined
  • 将
    package-name
    从1.0.0版本更新至2.0.0版本
undefined

Information Gathering

信息收集

Git Commands

Git命令

bash
undefined
bash
undefined

Commits since last release

上一版本以来的提交记录

git log v1.1.0..HEAD --oneline
git log v1.1.0..HEAD --oneline

Detailed commit messages

详细提交信息

git log v1.1.0..HEAD --format="%h %s%n%b%n---"
git log v1.1.0..HEAD --format="%h %s%n%b%n---"

Files changed

变更文件统计

git diff v1.1.0..HEAD --stat
git diff v1.1.0..HEAD --stat

Contributors

贡献者列表

git log v1.1.0..HEAD --format="%an" | sort | uniq
undefined
git log v1.1.0..HEAD --format="%an" | sort | uniq
undefined

Writing Guidelines

撰写指南

Highlights Section

重点摘要部分

Focus on user value:
  • What can users do now that they couldn't before?
  • What problems are solved?
  • Why should they upgrade?
聚焦用户价值：
  • 用户现在能做哪些之前无法完成的事？
  • 解决了哪些问题？
  • 用户为何应该升级？

Feature Descriptions

功能描述

Include:
  • What it does
  • Why it matters
  • Basic usage example
需包含：
  • 功能作用
  • 重要性
  • 基础使用示例

Breaking Changes

破坏性变更

Must include:
  • Clear description of what changed
  • Why it changed
  • Step-by-step migration guide
  • Code examples (before/after)
必须包含：
  • 清晰描述变更内容
  • 变更原因
  • 分步迁移指南
  • 代码示例（变更前后对比）

Version Numbers

版本号规则

Follow semantic versioning:
  • Major (1.0.0): Breaking changes
  • Minor (0.1.0): New features, backward compatible
  • Patch (0.0.1): Bug fixes, backward compatible
遵循语义化版本（semantic versioning）规范：
  • 主版本（1.0.0）：包含破坏性变更
  • 次版本（0.1.0）：新增功能，向后兼容
  • 修订版本（0.0.1）：问题修复，向后兼容

Example Release Notes

版本说明示例

markdown
undefined
markdown
undefined

Release v1.2.0

Release v1.2.0

Highlights

重点摘要

This release adds health data visualization and improves task scheduling performance. Users can now view their health trends over time.
本次版本新增健康数据可视化功能，同时提升了任务调度性能。用户现在可以查看自身健康数据的时间趋势。

New Features

新功能

Health Data Visualization

健康数据可视化

View your health metrics in interactive charts.
Usage:
typescript
import { HealthChart } from './components/health';

<HealthChart data={healthData} timeRange="week" />
通过交互式图表查看健康指标。
使用示例：
typescript
import { HealthChart } from './components/health';

<HealthChart data={healthData} timeRange="week" />

Improvements

优化改进

  • Task scheduling is now 50% faster
  • Improved error messages for authentication failures
  • 任务调度速度提升50%
  • 优化了认证失败时的错误提示信息

Bug Fixes

问题修复

  • Fixed race condition in account state initialization (#45)
  • Resolved infinite loop when no tasks exist (#52)
  • 修复了账户状态初始化时的竞态条件问题（#45）
  • 解决了无任务时的无限循环问题（#52）

Breaking Changes

破坏性变更

useHealthData Hook

useHealthData Hook

What changed: 
useHealthData()
now returns an object instead of array
Migration:
typescript
// Before
const [data, isLoading] = useHealthData();

// After
const { data, isLoading } = useHealthData();
undefined
变更内容： 
useHealthData()
现在返回对象而非数组
迁移指南：
typescript
// Before
const [data, isLoading] = useHealthData();

// After
const { data, isLoading } = useHealthData();
undefined

Checklist

检查清单

  • Highlights summarize key changes
  • All new features documented with examples
  • Breaking changes have migration guides
  • Bug fixes reference issue numbers
  • Version number follows semver
  • 重点摘要概述了核心变更
  • 所有新功能均附带示例文档
  • 破坏性变更包含迁移指南
  • 问题修复关联了对应工单编号
  • 版本号遵循语义化版本规范