私はコードをチェックインするときに、非常に長く、詳細なチェックインノートを書きますが、他のときは非常に短いものを書いています。長いノートには、変更が行われた理由（ビジネス上の理由、顧客のやりとりなど）に関する情報が含まれている傾向があります。しかし、チェックインノートがそのような詳細のための適切な場所であるかどうかはわかりません。私が見てきたほとんどのチェックインノートは短くてバグを参照する傾向があります。チェックインノートの詳細レベルはどれくらいですか？
チェックインノートの詳細レベルはどれくらいですか？上司や会社のドキュメントはあなたを伝えるものは何でも
正しい回答は、組織のニーズに依存していることがわかりました。それはあいまいですが、コードチェックインの詳細を提供する主な理由は、そのチェックインをレビューまたは再訪する必要がある場合、コンテキストと理解のためです。それは信じられないほど冗長かもしれないし、非常に単純かもしれない。
当社のコードチェックインでは、＃+チケット番号が参照されます。このマッピングされたSVNは、Tracのチケット番号に対してコミットしています。チケット番号は、実装している特定の問題または機能に関するすべての詳細を保持しています。私たちはTracを通じてすべてを参照していました。
あなたにとっては、あなたとあなたのチームの仕組みによって異なります。私はあなたのチェックインの情報を、データの必要性、参照される頻度、コンテキストが失われた場合（つまり、なぜ変更が実装されたのか分かりません）などの理由に基づいています。
コード・リポジトリーの外側のノートにアクセスしている可能性があります。これは、その情報を格納する最も有効なメカニズムではない可能性があります。それにもかかわらず、私はそれが個人的な好みだと思う。
;）言われていること
は、短い方が良いです。これは長いドキュメントの正しいツールではありません。あなたのバグ/フィーチャトラッキングソフトウェアは、このために構築されており、ほとんどの場合、ソースコントロールと統合できます。
何週間か後にログをたどって、何が邪悪なのかを知るにはちょうだい。
私はこれらのログを使用して、私が主導しているプロジェクトの最終日（または日）に行われたことを確認します。
メッセージを短くする必要はありません。もはやメッセージ。これらのコメントの目的を念頭に置いてください：バージョン管理システムの活動の概要を説明すること。
私のバージョン管理の経験では、ノートをまったく残していないものや、掘り下げるのに5分かかるノートを呪う傾向があります。
バージョンコントロールシステムを使用して特定の変更を見つけるためにファイルの履歴を参照する場合は、その理由とその内容に短いコメントを追加することをお勧めします。どのようにソースコードのドキュメントに入ることです。
私がコメントやコミットログメッセージを書くたびに、「次の人は何を知る必要がありますか？彼らは私に尋ねる可能性が高いのですか？
質問に答えると、コメントを簡単かつ便利に保つことができます。また、反ドキュメンテーション（コードを誤って皮肉な言い方で言い直すことを避ける）や、vcsがとにかく追跡しているメタデータ（foo.java、火曜日の変更、新しいタグ "bar-1-1-4"を付け加えた）を改言することも避けてください。