write-conventional-commit について
Gitの変更を確認し、Conventional Commitメッセージを作成するスキルです。ステージ済みと作業ツリーの差分を調べ、主な変更意図に基づいてタイプを一つ選び、メッセージを一つ出力します。
主な機能
- 01Gitの状態と差分を確認
- 02必要に応じて作業ツリーの差分を参照
- 03主な変更意図に基づきタイプを選択
- 04Conventional Commit規則に沿ってメッセージを作成
活用シーン
- 01ステージ済み変更のコミットメッセージを作成
- 02未ステージ変更のメッセージを作成
- 03コードや文書の変更に適したタイプを選択
インストール
コマンドをコピーしてターミナルで実行します。
$
npx skills add https:/インストール後、Claude Code で/write-conventional-commitを入力して読み込まれたか確認します。
同梱ファイルagents/openai.yaml
詳細
Conventional Commit を作成
Git の変更を確認し、Conventional Commit メッセージを作成します。
ワークフロー
git status --shortを実行します。- ステージ済みまたは未ステージの変更がない場合は、
No staged or unstaged changes found.と返信します。 git diff --staged --no-ext-diff --statを実行します。git diff --staged --no-ext-diffを実行します。- ステージ済みの差分が空で、作業ツリーに変更がある場合は、代わりに
git diff --no-ext-diff --statとgit diff --no-ext-diffを使用します。 - 差分から主な意図を判断し、メッセージを1つだけ作成します。
コミットタイプ
次のリストからタイプを必ず1つ選びます。
- feat: 新機能
- fix: バグ修正
- docs: ドキュメントのみの変更
- style: コードの意味に影響しない変更（空白、フォーマット、セミコロンの不足など）
- refactor: バグ修正にも機能追加にも該当しないコード変更
- perf: パフォーマンスを改善するコード変更
- test: 不足しているテストの追加、または既存テストの修正
- build: ビルドシステムや外部依存関係に影響する変更
- ci: CI 設定ファイルやスクリプトの変更
- chore: src ファイルや test ファイルを変更しないその他の変更
Conventional Commit のルール
- 主な意図を選びます。タイプを組み合わせてはいけません。
- 件名の末尾にピリオドを付けてはいけません。
- 変更に互換性を破壊する内容がある場合は、タイプまたはスコープの後に
!を付け、追加の移行情報が必要な場合はBREAKING CHANGE:フッターを含めます。 - 件名は簡潔にし、50～72文字を目安にします。
- Markdown のコードフェンス、箇条書き、分析、コメントは含めてはいけません。
- 短い説明の後に、コード変更の背景を補足する本文を記載することを推奨します。
- 固有名詞や略語で大文字が必要な場合を除き、コロンの後は小文字にします。
- 文脈に明確に含まれている有用なトレーラーやフッター情報は保持します。
- スコープは任意です。明確で、本当に有用な場合にのみ使用します。
- 件名は命令形で記述します。
コメント
Markdown 対応