コミットメッセージ規約プロンプト
初級
このプロンプトでできること
AIにGitコミットメッセージの規約を設定するプロンプトです。チーム全体で一貫性のあるコミット履歴を維持できます。
プロンプト
Gitコミット時は以下の規約に従ってコミットメッセージを作成してください。
【フォーマット】
<type>: <subject>
<body>
<footer>
【Type一覧】
- feat: 新機能の追加
- fix: バグ修正
- docs: ドキュメントのみの変更
- style: コードの意味に影響しない変更(空白、フォーマット等)
- refactor: バグ修正や機能追加を伴わないコード変更
- test: テストの追加・修正
- chore: ビルドプロセスや補助ツールの変更
【Subject(件名)のルール】
- 50文字以内
- 日本語で記述
- 文末に句点をつけない
- 命令形で記述(「追加する」ではなく「追加」)
【Body(本文)のルール】
- 72文字で改行
- 「何を」「なぜ」変更したかを記述
- 箇条書きを活用
【Footer(フッター)】
- 関連Issue: Closes #123
- 破壊的変更: BREAKING CHANGE: 説明
【コミット前チェック】
1. テストがすべて通過していることを確認
2. 静的解析でエラーがないことを確認
3. 変更内容に秘密情報が含まれていないことを確認
カスタマイズ例
Emoji付きコミット(Gitmoji風)
【Type一覧(Emoji付き)】
- ✨ feat: 新機能
- 🐛 fix: バグ修正
- 📝 docs: ドキュメント
- 💄 style: UIやスタイル
- ♻️ refactor: リファクタリング
- ✅ test: テスト
- 🔧 chore: 設定変更
スコープ付き(Angular風)
【フォーマット】
<type>(<scope>): <subject>
【Scope例】
- auth: 認証関連
- api: API関連
- ui: UI関連
- db: データベース関連
英語版
【Subject Rules】
- Use imperative mood ("Add" not "Added")
- Capitalize first letter
- No period at the end
- Max 50 characters
出力例
機能追加
feat: ユーザープロフィール編集機能を追加
- プロフィール画像のアップロード機能
- 表示名の変更機能
- 自己紹介文の編集機能
Closes #45
バグ修正
fix: ログイン時のセッション切れを修正
ログイン後24時間でセッションが切れる問題を修正。
トークンのリフレッシュ処理が正しく動作していなかった。
- リフレッシュトークンの有効期限を修正
- 自動リフレッシュ処理を追加
Closes #123
リファクタリング
refactor: 認証ロジックをサービスクラスに抽出
コントローラーに散在していた認証ロジックを
AuthServiceクラスに集約。
- 重複コードの削除
- テスタビリティの向上
- 責務の明確化
破壊的変更
feat: APIレスポンス形式を変更
レスポンスにページネーション情報を追加。
BREAKING CHANGE: レスポンスのルートが配列から
オブジェクトに変更。data配列とmeta情報を含む形式に。
Before: [{ id: 1 }, { id: 2 }]
After: { data: [...], meta: { total: 100, page: 1 } }