良いコミットとは何か | 仕組み解説

Gitでは、変更をcommitとして記録します。しかし、何でもまとめてcommitすればよいわけではありません。良いcommitは、あとから読んだ人が変更理由を理解しやすい単位です。

一言でいうと

良いコミットは、「1つの目的」にまとまっていて、あとから変更理由を追える記録です。

update
fix
いろいろ変更
作業

これでは、あとから履歴を見ても何をしたかわかりません。

差分も、機能追加、バグ修正、フォーマット、README更新が全部混ざっていると読みにくくなります。

feat: add login form
fix: handle empty search keyword
docs: update setup instructions
test: add user service tests

英語でも日本語でも構いませんが、目的がわかるようにします。

fix: 空の検索キーワードで全件表示される問題を修正

良い粒度は、次の問いで確認できます。

commitは作業時間の区切りではなく、意味の区切りで作ります。

次の変更は、分けた方が読みやすいです。

良いcommitは、1つの目的にまとまり、差分が読めて、変更理由がわかる記録です。作業時間ではなく意味の区切りでcommitを作ります。大きな変更、README、フォーマット、テストは、必要に応じて分けると履歴が読みやすくなります。