mcpField
R
release-notes-generator

release-notes-generator

github.com/stanfordspezi开发26113 次安装4 周前更新
代码仓库

关于 release-notes-generator

release-notes-generator 是用于撰写单个软件版本说明的技能，面向开发者。它按功能、改进、修复和依赖等内容组织说明，并指导记录破坏性变更的迁移步骤。

主要功能

  1. 01按版本说明章节组织内容
  2. 02总结新功能与改进
  3. 03记录错误修复和依赖更新
  4. 04提供破坏性变更迁移指引
  5. 05采用语义化版本指导

适用场景

  1. 01发布新版本说明
  2. 02向用户和相关方概述更新
  3. 03说明破坏性变更的迁移步骤

安装

复制下面的命令，在终端中运行。

$npx skills add https://github.com/stanfordspezi/spezivibe --skill release-notes-generator

安装后在 Claude Code 中输入/release-notes-generator确认已加载。

详细介绍

版本说明生成器

为版本发布创建版本说明，汇总新功能、修复和破坏性变更。

何时使用

当你需要以下操作时，请使用此技能：

  • 为新版本准备版本说明
  • 为用户/利益相关者汇总变更
  • 为破坏性变更记录迁移步骤

当你需要维护项目的 CHANGELOG.md 文件时，请改用 keep-a-changelog-generator。此技能为单个版本撰写叙述性公告；那个技能则维护结构化的累积变更日志。

版本说明结构

# Release v1.2.0

## Highlights

Brief summary of the most important changes (2-3 sentences).

## New Features

### Feature Name
Description of what it does and why it matters.

**Usage:**
```typescript
// Code example

改进

  • 改进 1
  • 改进 2

缺陷修复

  • 修复了 X 的问题 (#123)
  • 解决了 Z 情况下的 Y

破坏性变更

变更名称

变更内容： 描述

迁移：

// Before
oldMethod();

// After
newMethod();

依赖项

  • 将 package-name 从 1.0.0 更新到 2.0.0

## Information Gathering

### Git Commands

```bash
# Commits since last release
git log v1.1.0..HEAD --oneline

# Detailed commit messages
git log v1.1.0..HEAD --format="%h %s%n%b%n---"

# Files changed
git diff v1.1.0..HEAD --stat

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

撰写指南

亮点部分

聚焦用户价值：

  • 用户现在能做哪些以前做不到的事？
  • 解决了哪些问题？
  • 他们为什么应该升级？
功能描述

包括：

  • 它做什么
  • 为什么重要
  • 基本用法示例
破坏性变更

必须包括：

  • 对变更内容的清晰描述
  • 变更原因
  • 分步迁移指南
  • 代码示例（之前/之后）
版本号

遵循语义化版本：

  • 主版本 (1.0.0)：破坏性变更
  • 次版本 (0.1.0)：新功能，向后兼容
  • 补丁 (0.0.1)：缺陷修复，向后兼容

版本说明示例

# 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" />

改进

  • 任务调度现在快了 50%
  • 改进了身份验证失败的错误消息

缺陷修复

  • 修复了账户状态初始化中的竞态条件 (#45)
  • 解决了无任务时的无限循环 (#52)

破坏性变更

useHealthData Hook

变更内容： useHealthData() 现在返回对象而不是数组

迁移：

// Before
const [data, isLoading] = useHealthData();

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


## 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

评论

支持 Markdown