SVNコミットのヒント

リポジトリへのコミットに関するヒントを含む良い記事を翻訳することを提案します。 オリジナルはT2プロジェクト用に作成されましたが、ほとんどすべてのヒントは普遍的であり、他のプロジェクトにも簡単に適用できます。 そして最も重要なこと-彼らは本当に便利です。



更新: SVNは記事のタイトルに表示されますが、SVNで説明されているヒントは、私が知っているすべてのバージョン管理システムに適用されます。 また、ヒントが主にチーム開発を目的としていることも注目に値します。



変更をコミットする前によく考えてください



なぜなら SVNに変更をコミットすると、重大な結果を招く可能性があります。コードが他の開発者から何かを壊していないかどうかを把握するために時間をかけてください。 結局のところ、コードリポジトリは万人のためのものであり、何かを壊せば、誰にとっても壊れてしまいます。 もちろん、SVNを使用すると以前のバージョンに戻ることができ、これは問題の解決に役立ちますが、後で英雄的に修正するよりも、問題を防ぐ方がよいでしょう。



コンパイルしないコードをコミットしない



ご注意 Per。:このパラグラフでは、コンパイルについて説明していますが、これはWeb開発には関係ありませんが、コンパイルがエラーがないと理解されている場合、パラグラフはWebアプリケーションにとって非常に意味があります。



変更をリポジトリにコミットする前に、コードをコンパイルしてすべてのエラーを修正します。 新しいファイルがコミットされていることを確認してください。 それらが存在しない場合、コードはローカルでコンパイルされ、残りのすべてはこれを行うことができません。



コードがローカル設定およびプラットフォームでコンパイルされることを確実に確認する必要があります。 また、異なるアーキテクチャでコンパイルしたコミットの結果も考慮する必要があります。



コミットする前に変更をテストする



アプリケーションを起動し、変更の影響を受けた可能性のあるサイトの動作を確認して、変更が意図したとおりに動作することを確認します。



修正内容を再確認してください



コミットする前に「svn up」と「svn diff」を実行してください。 競合、不明なファイルなどに関するメッセージをSVNから受信します。 「Svn diff」は、修正内容を正確に示します。 これが本当にあなたがコミットしようとしていたものであるかどうかを確認してください。



常に意味のあるコメントをコミットに追加します



ログのみを表示するユーザーには、コメントを明確にする必要があります。 コミットのコンテキスト外の情報に依存するべきではありません。 コメントに記載されている変更で実際に影響を受けるファイルのみを記載してください。



実際には、diffコマンドの出力からは見えないすべての重要な情報をコメントに含めてください。



バージョン管理は、開発者間のコミュニケーションに代わるものではありません



SVNのさまざまなコードに影響を与える変更を行う予定がある場合は、事前にサブスクリプションシートでお知らせください。



ライブラリで新しい関数を使用するように切り替えるなど、SVNの多くのコードに影響する変更は、些細に思えても他のコードを壊す可能性があります。 このような変更は、多くの理由でアプリケーションが古いライブラリでコンパイルする必要があるため、危険な場合があります。 事前に変更を発表することで、開発者は何かが壊れる前に懸念を準備して発言することができます。



自分のコミットメントに責任を持つ



コミットが何かを壊したり、コードの他の部分に副作用がある場合は、責任を持って修正するか、他の人が問題を修正するのを手伝ってください。



理解できないコードをコミットしないでください



次のような状況は避けてください:「なぜクラッシュするのかわかりませんが、クラッシュしてもクラッシュしません」または「正しいかどうかはよくわかりませんが、少なくとも私にはうまくいきます。」



問題の解決策が見つからなかった場合は、他の開発者と話し合ってください。



SVNアカウントを悪用して、他の開発者によって拒否された変更をプッシュしないでください。



コードの変更について意見の相違がある場合は、メーリングリストまたはプライベートで議論することで解決する必要があります。他のコードを強制的に置き換えるのではなく、単にリポジトリに変更をコミットするだけです。



バグ修正をコミットする場合、修正を他のブランチに移動することを検討してください



メインの修正とポータブルの両方のコミットに同じコメントを使用します(メインのコミットのリビジョン番号をコメントに追加するだけです)。 これにより、どの修正が既に移行されたかを簡単に確認できます。



エラーアカウンティングシステムに記録されたエラーを修正する場合は、コメントにエラー番号を追加してください





エラーアカウンティングシステムとSVNの同期を維持するには、コミットへのコメントでエラー番号を指定してから、アカウンティングシステムでエラーを閉じる必要があります。



アトミックコミットを作成する



SVNには、一度に複数のファイルをコミットする機能があります。 したがって、関連するすべての変更を一度に複数のファイルにコミットしてください(一度に複数のディレクトリにまたがっていても)。 したがって、リポジトリはコンパイルされた状態のままになります(つまり、リポジトリ内のコードはエラーなしでコンパイルされます(およそ))。コミットの前後、および変更セットはマージまたはロールバックが容易です。



書式の変更とコードの変更を混在させないでください



インデントやスパースなどのコードのフォーマットを変更すると、差分が爆発するだけで、フォーマットと混在しているコードの変更を見つけるのは非常に困難です。 フォーマットの変更を個別にコミットすると、この問題は解決します。



PS: クロスポスト-lobach.info/develop/svn/svn-commit-tutorial






All Articles