Keep a Changelog形式：完全ガイド
リリースノートのためのKeep a Changelog形式の包括的なガイド。6つの標準カテゴリ、ヘッダー形式、仕様への準拠について解説します。
Templates
詳細な説明
Keep a Changelog形式
Keep a Changelogは、チェンジログとリリースノートのフォーマットとして最も広く採用されている標準です。人間とマシンの両方が読みやすい一貫した構造を提供します。
6つのカテゴリ
| カテゴリ | 使用する場合 |
|---|---|
| Added | 新機能、新しいAPI、新しいCLIコマンド |
| Changed | 既存の動作への変更、依存関係の更新 |
| Deprecated | 将来のバージョンで削除予定の機能（まだ動作するが警告あり） |
| Removed | このバージョンで削除された機能 |
| Fixed | バグ修正、既存の動作の修正 |
| Security | 脆弱性パッチ、セキュリティ改善 |
ルール
- 各バージョンは日付付きの専用セクションを持つ
- カテゴリはエントリがある場合のみ表示（空のカテゴリは省略）
- バージョンは逆時系列順でリスト（最新が最初）
[Unreleased]セクションで今後の変更を収集- ISO 8601日付形式を使用（YYYY-MM-DD）
- 可能な場合、バージョンヘッダーをdiff URLにリンク
避けるべきアンチパターン
- 生のgitコミットメッセージをダンプする
- 一貫しない日付形式を使用する
- 説明なしに内部チケット番号を含める
- ユーザーの視点ではなく開発者の視点で書く
ユースケース
新しいオープンソースプロジェクトのチェンジログを設定する場合や、既存の非構造化チェンジログをKeep a Changelog標準に移行して、可読性と一貫性を向上させる場合。