変更ログジェネレーター
このスキルは、技術的なGitコミットを洗練されたユーザーフレンドリーな変更ログに変換します。お客様やユーザーが実際に理解し、評価できる内容になります。
このスキルを使用すべきタイミング
- 新バージョンのリリースノートを準備する
- 週次または月次の製品アップデートの概要を作成する
- 顧客向けの変更内容を文書化する
- アプリストア提出用の変更ログエントリを作成する
- アップデート通知を生成する
- 社内リリースドキュメントを作成する
- 公開変更ログ/製品アップデートページを維持する
このスキルの機能
- Git履歴のスキャン: 特定の期間またはバージョン間のコミットを分析
- 変更の分類: コミットを論理的なカテゴリ(機能、改善、バグ修正、破壊的変更、セキュリティ)にグループ化
- 技術的な内容をユーザーフレンドリーに変換: 開発者のコミットを顧客の言葉に翻訳
- プロフェッショナルなフォーマット: クリーンで構造化された変更ログエントリを作成
- ノイズのフィルタリング: 内部コミット(リファクタリング、テストなど)を除外
- ベストプラクティスに従う: 変更ログガイドラインとブランドボイスを適用
使用方法
基本的な使い方
プロジェクトリポジトリから:
前回のリリース以降のコミットから変更ログを作成して
過去1週間の全コミットの変更ログを生成して
バージョン2.5.0のリリースノートを作成して
特定の日付範囲を指定する場合
3月1日から3月15日までの全コミットの変更ログを作成して
カスタムガイドラインを使用する場合
v2.4.0以降のコミットから変更ログを作成して。CHANGELOG_STYLE.mdから変更ログガイドラインを使って
例
ユーザー: 「過去7日間のコミットから変更ログを作成して」
出力:
# アップデート - 2024年3月10日週
## ✨ 新機能
- **チームワークスペース**: プロジェクトごとに個別のワークスペースを作成。チームメンバーを招待して、すべてを整理整頓できます。
- **キーボードショートカット**: ? を押すと、利用可能なすべてのショートカットが表示されます。マウスを使わずに高速に操作できます。
## 🔧 改善
- **より高速な同期**: ファイルのデバイス間同期が2倍高速化
- **より優れた検索**: 検索にファイルの内容も含まれるようになりました(タイトルだけでなく)
## 🐛 修正
- 大きな画像がアップロードできない問題を修正
- スケジュール投稿におけるタイムゾーンの混乱を解消
- 通知バッジのカウントを修正
インスピレーション元: Lenny's Newsletter での Manik Aggarwal のユースケース
ヒント
- Gitリポジトリのルートから実行してください
- 日付範囲を指定して、焦点を絞った変更ログを作成できます
- CHANGELOG_STYLE.mdを使用して一貫したフォーマットを適用してください
- 公開前に生成された変更ログを確認し、調整してください
- 出力を直接CHANGELOG.mdに保存できます
関連するユースケース
- GitHubリリースノートの作成
- アプリストアのアップデート説明文の作成
- ユーザー向けのメールアップデートの生成
- ソーシャルメディアのお知らせ投稿の作成