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