Gitのコメントってどう書いたらいいのかなー？
Gitでコードを管理していると、何度も出てくるのが「コミットメッセージ」。
「修正」「更新」「直した」など、つい適当に書いてしまうこともあるのではないでしょうか？
実は、コミットメッセージにはプロジェクトの未来を左右する力があります。
この記事では、初心者エンジニアでもすぐ実践できる、わかりやすいコミットメッセージの書き方をご紹介します。
（と言っておりますが、自己学習用の覚え書きです。）
なぜコミットメッセージが大切なの？
コミットメッセージが適当だと、あとからコードを見返したときに「何をしたのか」がまったく分かりません。
自分だけでなく、他のメンバーが見ても理解できるメッセージを残すことが大切です。
例えば次のような場面で役立ちます。
- 過去の修正内容を確認したいとき
- バグの原因を特定するとき
- プルリクエストの内容を説明するとき
「誰が」「いつ」「どのコードを」「なぜ」変更したのかが一目でわかるようにしましょう。
コミットメッセージの基本ルール
1行目に要約を書く（50文字以内が目安）
コミットの目的を一言で表す短い文にしましょう。
ログインエラーの表示文言を修正2行目は空ける
Gitのツールは、1行目と本文を分けて読みやすく表示するため、空行を入れるのが基本です。
3行目以降に詳細を書く（必要な場合）
なぜこの変更が必要だったのか、どんな影響があるのかなどを記述します。
エラーメッセージが英語のままだったため、日本語に修正しました。よく使うコミットの「タイプ」一覧
コミットメッセージの冒頭に「タイプ」を付けると、より整理しやすくなります。
以下はよく使われるタイプの一覧です。
| タイプ | 内容 |
|---|---|
| feat | 新しい機能の追加 |
| fix | バグ修正 |
| docs | ドキュメントのみの変更 |
| style | フォーマット調整など |
| refactor | コード整理（機能変更なし） |
| test | テスト関連の追加や修正 |
| chore | 雑務的な変更（ビルド設定など） |
fix: ログイン時にクラッシュする問題を修正
docs: READMEに開発手順を追記日本語でもOK？書き方の例
初心者のうちは、日本語で書いても大丈夫です。
重要なのは「誰が見てもわかること」。
[修正] ログインボタンが押せない問題を対応
[追加] ユーザー検索機能を追加チームのルールがある場合は、それに従いましょう。
コミットメッセージのコツ
- 書く前に「この変更を未来の自分が見たら、分かるか？」を考える
- 単語ではなく、文章で説明する
- 同じ作業でも細かく分けて、意味のある単位でコミットする
まとめ
Gitのコミットメッセージは、ただのメモではありません。
自分やチームの開発効率を大きく左右する重要なドキュメントです。
慣れるまでは少し面倒に感じるかもしれませんが、少しずつ「意味のあるメッセージ」を意識することで、コードの信頼性も高まります。
まずは「何を・なぜ・どうしたか」を意識して書くことから始めてみましょう。
コメント