Linuxのカーネル管理などにも利用されている多機能バージョン管理システム「Git」。
ついおろそかになりがちですが、有効に使いこなすためには分かりやすいコミットメージを追加していく事が重要となります。
本日紹介する「Commit messages guide」はそのコミットメッセージをいかに書けば良いかを説明する詳細なドキュメントです。
なお日本語訳は存在しますが、ガイドの内容は英語でコミットメッセージを書くためのものとなっています。オープンソースプロジェクトなどで分かりやすいコミットメッセージを追加したいという方に参考になる情報です。
目次
なぜコミットメッセージは重要なのか？
ガイドは、Gitの「コミット」の概念や「なぜコミットメッセージは重要なのか?」といった基本的な部分から説明が始まります。
コミットメッセージが重要な理由としては、「素早く効率的にコードレビューをするため」や「変更を理解するのを助けるため」、「コードのみで説明できない"なぜ"を説明するため」、「未来のメンテナのため」などが挙げられており、これを実践するための具体的なグッドプラクティスもリストアップされています。
例えば「命令形を使う」とか「最初の文字を大文字にする」、「ソースコードを見ることなく変更を伝えられるようにする」などの良い事例が紹介されています。
その他、メッセージの件名と本文の使い分け方や、文字数の制限など、従った方が好ましいルールに関しても説明されています。
まとめ
Commit messages guideにはGitで英語のコミットメッセージを書く際役立つ情報が掲載されています。英語のプロジェクトで作業している方は参考にしてみてはいかがでしょうか。
