$Git Simulator
壊しても大丈夫。全部ブラウザの中だけで動いています

コミットメッセージと作法

Git の操作を覚えたら、次は「読みやすい履歴を残す」段階です。履歴は未来の自分とチームメイトへの手紙です。

コミットの粒度

1 コミット = 1 つの意味のある変更 が理想です。

  • ○ ログインフォームのバリデーションを追加
  • ○ typo を修正
  • ✗ いろいろ修正(README の修正とバグ修正と新機能が混ざっている)

小さいコミットの利点:

  • 履歴を読めば「何をしたか」が追える
  • 問題が起きたとき、どのコミットが原因か特定しやすい
  • revert で特定の変更だけを戻せる
  • レビューしやすい

「関係ない変更を分ける」には、ステージングエリアが役立ちます。ファイル単位で git add すれば、別々のコミットにできます。

コミットメッセージの書き方

1 行目(タイトル)

  • 何をしたか を簡潔に。50 文字程度まで
  • 「〜を追加」「〜を修正」「〜を削除」「〜をリファクタ」など動詞で始めると読みやすい
  • 「WIP」「fix」「update」だけ、のような中身のない言葉は避ける
○ ユーザー一覧に検索機能を追加
○ ログイン失敗時にエラーメッセージが出ない問題を修正
✗ 修正
✗ aaa

本文(任意)

1 行空けて、なぜ その変更をしたのかを書きます。何をしたかは diff を見れば分かりますが、理由は書かないと残りません。

ログイン失敗時にエラーメッセージが出ない問題を修正

API のエラーレスポンスの形式が変わったため、
message フィールドではなく error.message を参照するようにした。
関連: #42

複数段落を -m で書くには git commit -m "タイトル" -m "本文" とします。

Conventional Commits

チームによっては、接頭辞でコミットの種類を示すルールを使います。

feat: 検索機能を追加
fix: ログインエラーを修正
docs: README を更新
refactor: ユーザー取得処理を整理
test: 検索のテストを追加
chore: 依存パッケージを更新

ツールで CHANGELOG を自動生成できるなどの利点があります。参加したチームのルールに合わせましょう。

.gitignore

Git に記録すべきでないファイルがあります。

  • ビルド成果物(dist/, build/, *.o)
  • 依存パッケージ(node_modules/, vendor/)
  • ログ、一時ファイル(*.log, *.tmp, .DS_Store)
  • 秘密情報(.env, API キー、パスワード)

.gitignore ファイルにパターンを書くと、git status にも git add . にも出てこなくなります。

# 依存パッケージ
node_modules/

# ビルド成果物
dist/

# ログ・OS のゴミ
*.log
.DS_Store

# 秘密情報
.env

パターンの細かいルールや、自分だけの無視設定については .gitignore を使いこなす で詳しく解説しています。

.gitignore 自体はコミットして、チームで共有します。言語やフレームワークごとのテンプレートが GitHub の gitignore リポジトリ にあります。

一度コミットしてしまったファイルは、あとから .gitignore に書いても無視されません。 git rm --cached <file> で追跡から外す必要があります。秘密情報を push してしまった場合は、履歴から消すだけでなく キーそのものを無効化 してください。

日々の習慣

  • 朝イチで git pull。古い main で作業を始めると、あとでコンフリクトが増える
  • こまめにコミット。「区切りがついたら」ではなく「動いたら」コミット。まとめるのはあとでできる
  • git status を打ってから次の操作。今どこにいるか、何が変わっているかを常に把握
  • git diff --staged を見てからコミット。入れるつもりのないものが混ざっていないか
  • push する前に git log --oneline。変なコミットが混ざっていたら整えてから
  • 共有ブランチで --force と reset を使わない

困ったら聞く、その前に

「Git で変なことになった」と相談するとき、次を添えると解決が速くなります。

git status
git log --oneline --graph --all -20
git reflog -10

この 3 つの出力があれば、大抵の状況は把握できます。