Git コミットメッセージ ガイド
Gitのコミットメッセージを適切に記述することは、コードのメンテナンス性や可読性を向上させ、チーム開発における円滑なコミュニケーションにもつながります。以下に、日本語でのコミットメッセージのサンプルとその用途を分類して示します。
コミットメッセージの基本フォーマット
コミットメッセージの先頭には、次のような「タグ」を付けて変更の種類を明示します。
- feat: 新機能の追加
- fix: バグ修正
- refactor: リファクタリング（動作に影響しないコードの改善）
- docs: ドキュメントのみの変更
- perf: パフォーマンスの改善
- chore: その他の変更（ビルドプロセス、依存関係の更新など）
コミットメッセージ例
新機能追加
feat: キャラクターの移動機能を追加- キャラクターが移動できる新しい機能を実装。
feat: ログイン画面のUIを作成- 新しいログイン画面のユーザインターフェースを追加。
feat: 新しいスコアシステムを導入- スコアの計算方法を変更し、新システムを導入。
バグ修正
fix: プレイヤーが壁を通り抜けるバグを修正- 壁をすり抜ける不具合を修正。
fix: 誤ったスコア計算を修正- スコアが正しく計算されないバグを解消。
fix: エラー発生時のアラートメッセージを表示- エラーが発生した場合に適切なメッセージを表示するよう修正。
リファクタリング
refactor: コードの可読性を向上させるために変数名を変更- 変数名の変更により、コードがより分かりやすくなるよう修正。
refactor: 重複する処理を関数化- 同じ処理を複数箇所で行っていたため、関数にまとめて再利用可能に。
refactor: コードを整理し、無駄なコメントを削除- コードの整理と無駄なコメントを削除して、見やすく。
ドキュメント更新
docs: READMEにプロジェクトの使い方を追加- プロジェクトの使用方法についてREADMEに説明を追加。
docs: コードコメントを追加して可読性向上- コードにコメントを追加し、他の開発者が理解しやすく。
docs: APIドキュメントを更新- APIドキュメントを最新版に更新。
パフォーマンス向上
perf: レンダリング処理を最適化- レンダリング処理の高速化。
perf: キャッシュを利用してクエリ速度を改善- クエリ結果のキャッシュを有効化し、パフォーマンス向上。
perf: メモリ使用量を削減- メモリの使用を最適化し、効率を改善。
その他
chore: 不要なファイルを削除- 不要になったファイルを削除し、プロジェクトを軽量化。
chore: プロジェクトの依存関係を更新- 新しいライブラリやパッケージのバージョンに依存関係を更新。
chore: 設定ファイルの調整- ビルドや開発環境の設定ファイルを微調整。
コミットメッセージのポイント
- 簡潔さ – コミットメッセージはできるだけ簡潔に、かつ正確に変更内容を表現する。
- 一貫性 – タグの使い方や書き方に一貫性を持たせることで、メンテナンス性が向上。
- 意図の明示 – 変更内容の「何を」「なぜ」を明確にすることで、後から見直した際にも役立つ。
Gitのコミットメッセージは、チームでのスムーズな協力と、将来のメンテナンス性向上のために非常に重要なものです。このガイドを参考に、意図が明確で一貫性のあるメッセージを心掛けましょう。