keep-a-changelog-generator について
keep-a-changelog-generatorは、Gitの履歴から構造化された変更履歴を作成・管理するスキルです。プロジェクトのメンテナー向けに、Keep a Changelogの分類で変更を整理し、利用者向けの説明や破壊的変更の明示に対応します。
主な機能
- 01Git履歴から項目を生成
- 02変更を標準カテゴリに分類
- 03コミットを利用者向けに記述
- 04破壊的変更を明示
- 05CHANGELOG.md形式で出力
活用シーン
- 01リリース用の変更履歴を作成
- 02前バージョン以降の変更を記録
- 03プロジェクトのCHANGELOG.mdを管理
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/ / github.com/ stanfordspezi/ spezivibe --skill keep-a-changelog-generatorインストール後、Claude Code で/keep-a-changelog-generatorを入力して読み込まれたか確認します。
詳細
変更履歴ジェネレーター
Keep a Changelog 形式に従って、Git の履歴から変更履歴を生成します。
使用するタイミング
次のような場合に、このスキルを使用してください。
- リリースの変更履歴エントリーを生成する
- 前回のバージョン以降の変更を記録する
- プロジェクトの
CHANGELOG.mdファイルを管理する
ハイライト、使用例、移行ガイドを含む、物語形式のリリース告知が必要な場合は、代わりに release-notes-generator を使用してください。このスキルは構造化された CHANGELOG.md ファイルを管理し、もう一方は単一リリースのストーリーを作成します。
変更履歴の形式
Keep a Changelog に従ってください。
# Changelog
All notable changes to this project will be documented in this file.
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
## [Unreleased]
### Added
- New features
### Changed
- Changes in existing functionality
### Deprecated
- Features that will be removed
### Removed
- Removed features
### Fixed
- Bug fixes
### Security
- Security fixes
変更のカテゴリ
コミットメッセージとコードの変更に基づいて分類します。
| カテゴリ | コミットのキーワード | 例 |
|---|---|---|
| 追加 | add, create, implement, introduce | 新機能、画面 |
| 変更 | update, change, modify, refactor, improve | API の変更、機能強化 |
| 非推奨 | deprecate | 削除予定の機能 |
| 削除 | remove, delete, drop | 削除された機能 |
| 修正 | fix, resolve, correct, patch | バグ修正 |
| セキュリティ | security, vulnerability, CVE | セキュリティパッチ |
Git コマンド
# Recent commits
git log --oneline -20
# Commits between tags
git log v1.0.0..HEAD --oneline
# Full commit messages
git log --format="%h %s%n%b" HEAD~10..HEAD
# Commits since a date
git log --since="2026-01-01" --oneline
執筆ガイドライン
ユーザー向けの説明
技術的なコミット内容を、ユーザーにとってのメリットに置き換えます。
- 技術的な説明:「認証ステートマシンをリファクタリング」
- ユーザー向けの説明:「認証状態管理の信頼性を向上」
破壊的変更
API の変更を明確に示します。
### Changed
- **BREAKING**: `login()` now returns `Promise<User>` instead of `Promise<void>`
出力例
## [1.2.0] - 2026-01-14
### Added
- New health data visualization screen
- Apple HealthKit integration for step counting
- Export health data to PDF
### Changed
- Improved task scheduling performance
- Updated questionnaire UI design
### Fixed
- Fixed race condition in account state initialization
- Resolved infinite loop when no tasks exist
ワークフロー
git logを実行して、前回のリリース以降のコミットを取得します- コミットをカテゴリ(追加/変更/修正など)ごとにまとめます
- 破壊的変更を特定します
- ユーザー向けの説明を作成します
- 利用可能な場合は PR/issue の参照を含めます
- Keep a Changelog の構成に従って書式を整えます
コメント
Markdown 対応