SVN之使用原則

以下是我起草的部門SVN規范里原則的一部分。

1. 文件提交時要求必須提交注釋，注明相關修改信息，例如bug號、任務描述等。具體內容可采用約定或者設置的形式。
2. 你所提交的改變將體現給其他開發者，要明白提交的后果，提交之前要慎重。
3. 代碼變動及時提交，避免丟失本地修改后無法恢復。
4. ?在提交之前要編譯代碼并修正錯誤。要保證新增加的文件同時被提交，否則只在你本地能正常工作，導致其它人不能編譯通過。
5. 提交之前要測試所改變的應用，測試改變后的效果是否達到預期的目的。
6. ?多次檢查提交的內容。提交之前應先做SVN更新或與資源庫同步，注意到SVN關于沖突、錯誤的信息。資源庫同步會告訴你將要提交的內容與資源庫內容之間的差別，確認它們是不是你真正想要提交的。
7. 尊重其他開發者的代碼，在重大變更之前與他們協商。SVN并不能替代開發者之間的交流。
8. 提前宣布修改計劃。當你計劃進行修改，需要影響到SVN里的許多文件時，先通過郵件或者當面通知其他開發者。例如，修改底層數據庫模塊時，有可能影響到業務邏輯層調用數據庫模塊的地方。這樣其他開發者會有準備，也會對修改提出意見和建議。
9. 使用自動提交。SVN一次可以提交多個文件，所以，請一次提交所有相關的文件，即使它們不在目錄下。這樣可以確保代碼在提交前后都是正確的。
10. ?不要將格式修正和代碼修正混合提交。修正代碼格式包括增加縮進、減少空格等，如果把它們同代碼修正一起提交，很難從日志或資源庫同步信息里發現代碼的修正。所以應該把修正問題與修正格式分開提交。
11. 每次提交盡量是一個最小粒度的修改。比如一個debug提交一次，一個小功能提交一次。
12. 每日進行開發工作之前更新代碼。避免與昨天其他開發者的代碼沖突。
13. 所有的代碼文件編碼格式應該是UTF-8的。包括的類型如java, jsp, xml, php, html等。
14. 提交的文件必須是開發者共用的程序文件，私人測試程序、程序緩存、圖片緩存文件不要提交到SVN里。作為一個特例，eclipse的工程配置文件.project可以提交到SVN。一些常見的文件和目錄可以加到SVN屬性的忽略列表里，包括Thumbs.db、/build/、*.class、/classes/、/data/等等。