コミット前に見る差分と、メッセージの書き方

コミットに入る差分を確認するときは、ステージ前とステージ後を分けます。

git diff
git diff --staged

git diffは作業ツリーとインデックスの差分、git diff --stagedはインデックスとHEADの差分を表示します。通常のコミット前に、追加した変更を読む用途では後者を使います。git-diffの公式リファレンスでは--cachedも同じ指定として説明されています。

対象と変更を書く

「修正」だけだと、何が変わったかは差分を開くまでわかりません。対象と結果がわかる言葉にします。

次はConventional Commitsの形式を使う場合の例です。

feat: 記事一覧にタグの絞り込みを追加
fix: 長い見出しによる横スクロールを解消
docs: 記事を追加する手順を記載

一行で説明しにくい場合は、異なる目的の変更が混ざっていないか差分に戻ります。変更の理由や制約は、必要な分だけコミット本文に書きます。