commit - 適切なコミット メッセージ

Question

コミットメッセージとは何ですか? 私はいつも自分がしたことの説明としてそれらを書いてきましたが、最近、彼がした理由を説明するコミットメッセージを書いている同僚とそれについて話し合うようになりました。どちらが正しいですか、それとも完全に別の答えがありますか?

注：これに「正しい」答えがあるかどうかはまったくわかりません。そのため、私はこれをコミュニティ wiki とラベル付けし、回答を受け入れません。賛成票が勝者を決定します:)

Answer 1

個人的な好みとして、ファイルの違いを直接見ることで、何が行われたかを知ることができます。その理由は、実際の変化を見ただけでは推測できません。

変更が重要または複雑な場合は、理由だけでなく、方法の簡単な概要も含めます。

Answer 2

どちらも有用だと思います。特に複数のコミットを参照している場合は、何が変更されたかの簡単な説明 (「AddUserForm の長さ検証の追加」) は、差分を見るよりも簡単です。なぜ変更が加えられたのか、どのバグが修正されたのかなども明らかに非常に良いことです。

Answer 3

コミットメッセージはあなたが作るものですが、特定のファイルに数百、プロジェクトに数千のメッセージがある場合、それらをスキャンして特定の変更または変更の性質を探したいと思うでしょう。事実上、それらはコード コメントのようなものであり、可能な限り有用でありながら、簡潔で簡潔である必要があります。短いスペースで最大の意味を伝えるツイートと考えてください。

何十年にもわたる大規模なコード ベースと、1 年か 2 年にわたる小規模なプロジェクトに取り組んできた者として、コミット ログを調べているときに、「おっと」や「バグを修正しました」などのメッセージほど腹立たしいものはありません。バグを修正した場合は、どれを修正したか (少なくともバグ番号) をお知らせください。今後の必然的な法医学にとって、それはすべて重要です。

Answer 4

変更内容の要約としてコミット メッセージを使用します。

エグゼクティブ サマリーとは、[...] をまとめた短いドキュメントで、[...] をまとめたもので、読者が大量の資料をすべて読まなくてもすぐに理解できるようになっています。

理由は別の場所に文書化されています: 問題追跡システム、要件ドキュメントなど。コミット メッセージから理由へのリンク、およびその逆のリンクも含めます。