SVN提交原則

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

發佈了30 篇原創文章 · 獲贊 5 · 訪問量 2萬+
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章