| name | commit |
| description | Conventional Commitsに従ったコミットを実行する。変更差分を分析し、適切なtype・スコープ・メッセージを生成する。 |
| argument-hint | [-m <メッセージ>] |
コミットスキル
実行手順
git status と git diff --staged で変更内容を確認する
- 変更がステージされていない場合、関連ファイルをステージする
- 変更内容を分析し、以下のルールに従ってコミットメッセージを生成する
- ユーザーに確認を取った上でコミットを実行する
コミットメッセージのルール
type の選択基準
| type | 使用場面 |
|---|
| feat | 新機能の追加 |
| fix | バグの修正 |
| docs | ドキュメントのみの変更 |
| refactor | 機能変更を伴わないコード修正 |
| test | テストの追加・修正 |
| chore | ビルドやツールの設定変更 |
フォーマット
<type>: #<issue番号> <説明>
- 説明は日本語で記述する
- 50文字以内に収める
- 末尾にピリオドをつけない
- 命令形ではなく、変更内容の要約を書く
argument-hint の活用
-m オプションでメッセージを直接指定された場合は、そのメッセージを使用する。
指定がない場合は、差分から自動生成する。