コミットスキル
従来のコミットスタイルとアトミックコミットの原則に従って、変更をステージングおよびコミットします。
コミットメッセージ形式
<type>(<optional scope>): <short summary>
- すべて小文字 — タイプ、スコープ、要約
- 要約の末尾にピリオドは付けない
- 命令形 — 「add feature」と記述し「added feature」や「adds feature」とはしない
- 要約行は最大50文字(ソフトリミット、ハードリミット72文字)
- 要約は何をしたかではなくなぜしたかを説明する(差分が何を示すかはdiffが示す)
タイプ
| タイプ | 使用タイミング | 例 |
|---|---|---|
feat | 新機能または機能 | feat: add user authentication flow |
fix | バグ修正 | fix: resolve null pointer on empty input |
refactor | バグ修正でも機能追加でもないコード変更 | refactor: extract parser into standalone module |
style | 書式設定、空白、セミコロン — ロジック変更なし | style: apply formatter to config files |
docs | ドキュメントのみ | docs: add API usage examples to readme |
test | テストの追加または更新 | test: add edge case coverage for validator |
chore | ビルドプロセス、ツール、依存関係、設定 | chore: update dependency lockfile |
perf | パフォーマンスの改善 | perf: cache repeated database lookups |
ci | CI/CDパイプラインの変更 | ci: add lint step to PR workflow |
スコープ(任意)
タイプだけでは曖昧な場合に、スコープを使用してコンテキストを絞り込みます。スコープはプロジェクトのディレクトリ構造やドメイン領域から導出します:
feat(auth): add OAuth2 token refresh
fix(api): handle timeout on large payloads
docs(contributing): add setup instructions
ワークフロー
- 変更を確認 —
git statusとgit diff(ステージング済み+未ステージング)を実行して、何が変更されたかを把握する - 最近の履歴を確認 —
git log --oneline -10を実行して、プロジェクトの既存のコミットスタイルに合わせる - 意図を確認 — 変更が単一の論理単位を形成しているか確認し、そうでない場合は複数のコミットに分割することを提案する
- CIチェックを実行 — ステージング前に、プロジェクトのリンター、フォーマッター、テストスイートを実行して早期に問題を発見する。
package.jsonのスクリプト、Makefile、またはCI設定から利用可能なコマンドを確認する。障害は修正してから次に進む。 - ファイルをステージング — ファイルを名前で指定して追加する(
git add file1 file2)、git add -Aやgit add .は使用しない - メッセージを作成 — 正しいタイプを選択し、必要に応じてスコープを追加し、命令形の要約を書く
- コミット — ヒアドキュメントを使用してメッセージをクリーンにフォーマットする
- 確認 — コミット後に
git statusを実行してコミットが成功したことを確認する
マルチラインコミット
本文が必要なコミット(稀です — 簡潔な1行メッセージを優先):
<type>(<scope>): <summary>
<body explaining why, not what>
- 要約と本文の間に空行を入れる
- 本文は72文字で折り返す
- 要約だけでは理由を伝えきれない場合にのみ本文を使用する
ルール
- アトミックコミット — コミットごとに1つの論理変更。機能とそのテストは1つのコミットにできる。無関係なフォーマット修正は別のコミットにする。
- 機密情報なし —
.env、認証情報、APIキー、トークンを決してコミットしない。これらがステージングされている場合はユーザーに警告する。 - 生成成果物なし — ビルド出力、依存関係ディレクトリ、コンパイル済みファイルをコミットしない。ステージング前に
.gitignoreのカバレッジを確認する。 - 新規コミットのみ — 常に新しいコミットを作成する。ユーザーが明示的に依頼しない限り、決して修正(amend)しない。
- フックをスキップしない — 決して
--no-verifyを使用しない。フックが失敗した場合は、根本的な問題を修正する。 - 共同著者行 — Claudeが変更を作成または共同作成した場合、共同著者フッターを追加する:
Co-Authored-By: Claude <[email protected]>
例
# 機能 — 新機能
feat: add webhook notification system
# スコープ付き機能
feat(api): add rate limiting middleware
# 修正 — バグ修正
fix: prevent crash on malformed JSON input
# スタイル — フォーマットのみ
style: apply consistent indentation across modules
# ドキュメント — ドキュメント
docs: add architecture decision records
# 雑務 — ツール/設定
chore: broaden gitignore to cover build artifacts
# スコープ付きテスト
test(auth): add integration tests for token refresh
# スコープ付きリファクタリング
refactor(db): replace raw queries with query builder
参考ドキュメント
- conventional-commits.md — タイプ選択ガイド、破壊的変更、スコープ戦略、マルチファイルコミットの決定、本文のフォーマット、フッター、よくある間違い