git-commit
Git コミットのベストプラクティス。意味のある変更単位でのコミット、Conventional Commits ルール、コミットメッセージの書き方を定義。
When & Why to Use This Skill
This Claude skill optimizes your development workflow by enforcing Git commit best practices and the Conventional Commits standard. It guides developers to create meaningful, atomic commits and structured messages (feat, fix, refactor, etc.), ensuring a clean, searchable, and professional project history that facilitates easier debugging and team collaboration.
Use Cases
- Standardizing commit messages across a development team to maintain a consistent and readable Git history.
- Implementing Conventional Commits to enable automated changelog generation and semantic versioning.
- Ensuring atomic commits by guiding developers to stage only related changes, making code reviews and rollbacks more efficient.
- Onboarding new developers by providing a clear, guided framework for professional version control habits and documentation standards.
| name | git-commit |
|---|---|
| description | Git コミットのベストプラクティス。意味のある変更単位でのコミット、Conventional Commits ルール、コミットメッセージの書き方を定義。 |
Git コミットガイドライン
意味のある変更単位ごとにコミットを行うことは、コードの履歴を明確にし、将来の変更を追跡しやすくするために重要です。
Instructions
1. 変更を確認する
まず、現在のワーキングディレクトリでの変更を確認します：
git status
2. 変更をステージングする
変更をコミットする前に、ステージングエリアに追加する必要があります：
git add 対象ファイルやディレクトリ
重要：意味のある変更単位ごとにファイルを指定すること。無条件にすべての変更を追加しないでください。
3. コミットメッセージを作成する
コミットメッセージは、変更内容を簡潔に説明する重要な部分です：
git commit -m "コミットメッセージをここに入力"
コミットメッセージのルール
- コミットメッセージは日本語で記述
- Conventional Commits のルールに従う
- co-author やコミットメッセージに "Claude Code" のキーワードは含めない
Conventional Commits フォーマット
<type>(<scope>): <subject>
<body>
<footer>
type の種類：
feat: 新機能fix: バグ修正docs: ドキュメントのみの変更style: コードの意味に影響しない変更（空白、フォーマット等）refactor: バグ修正や機能追加ではないコード変更test: テストの追加・修正chore: ビルドプロセスやツールの変更
4. コミットを確認する
コミットが正しく行われたかを確認：
git log --oneline
Examples
機能追加のコミット
git add src/features/user-auth.ts
git commit -m "feat(auth): ユーザー認証機能を追加"
バグ修正のコミット
git add src/utils/validation.ts
git commit -m "fix(validation): メールアドレスのバリデーションエラーを修正"
ドキュメント更新のコミット
git add README.md docs/setup.md
git commit -m "docs: セットアップ手順を更新"
リファクタリングのコミット
git add src/services/api.ts
git commit -m "refactor(api): API クライアントの共通処理を抽出"
ベストプラクティス
- 1 コミット 1 目的：構造変更と動作変更を同一コミットに含めない
- 小さく頻繁に：大きな変更は小さなコミットに分割
- テスト通過後にコミット：壊れたコードをコミットしない
- 明確なメッセージ：何を、なぜ変更したかを簡潔に記述