メジャーバージョン(v2.0.0)のリリースノートの書き方

メジャーバージョンアップのための包括的なリリースノートの書き方。破壊的変更、新機能、移行ガイド、コントリビューターのクレジットの構成方法を解説します。

Major Releases

詳細な説明

メジャーリリースノートの構成

セマンティックバージョニングにおけるメジャーバージョンリリース(例:v2.0.0)は、ユーザーがコードを更新する必要がある破壊的変更を示します。メジャーバージョンのリリースノートは、ユーザーがアップグレードを計画するために依存するため、特に徹底的に作成する必要があります。

必須セクション

  1. バージョンヘッダー - 日付とオプションのコードネーム
  2. ハイライト概要 - 最も影響の大きい変更を2-3文で
  3. 破壊的変更 - 移行手順とともに目立つ位置に記載
  4. Added - すべての新機能
  5. Changed - 変更された動作
  6. Removed - 削除された機能
  7. Contributors - チームへの感謝

構成例

## [2.0.0] - 2026-02-28 (Aurora)

このリリースでは、完全に再設計されたAPI、ネイティブTypeScript
サポート、ツリーシェイキング互換性を導入しています。

### BREAKING CHANGES

> `init()`関数は位置引数の代わりに設定オブジェクトが必要になりました。
> 詳細は移行ガイドを参照してください。

### Added
- ネイティブTypeScript型定義
- ESMビルドのツリーシェイキングサポート
- 新しい`createClient()`ファクトリ関数

### Changed
- 最小Node.jsバージョンが18に変更
- デフォルトタイムアウトが5秒から30秒に増加

### Removed
- レガシーコールバックベースAPI(代わりにasync/awaitを使用)
- Node.js 14と16のサポート

### Contributors
- @alice - API再設計
- @bob - TypeScript型

ベストプラクティス

  • 破壊的変更がある場合は常に移行ガイドへのリンクを含める
  • 破壊的変更を影響領域別にグループ化する(API、設定、動作)
  • 変更されたAPIの変更前/変更後のコードスニペットを含める
  • 最小アップグレードパスに言及する(例:「まずv1.9にアップグレード」)

ユースケース

ユーザーが何が変わり、何が壊れ、既存のコードをどう移行すべきかの明確なガイダンスが必要な、オープンソースライブラリ、フレームワーク、CLIツールのメジャーバージョンをリリースする場合。

試してみる — Release Notes Generator

フルツールを開く