【轉】SVN提交一般原則

標籤：

 

寫在前面:

　　最近, 跳槽了.

　　來到了一家感覺QIAN景不錯的創業公司. 由於是開始, 規模比較小, SVN的管理工作, 也有我來承擔. 今天發生了一些相當不愉快的事情, 就是因為一個同事, ①簽入代碼無法編譯, ②簽入代碼不寫注釋, 找不到變更記錄. 找來這麼一篇文章放到部落格上, 希望能協助看到的各位.

 

=======================割==割===割=========================

　　最近在合作開發，用SVN給代碼和文檔做版本控制，由於是剛學會使用，總是問題多多：像檔案衝突，更新出問題等等，一開始以為很簡單的SVN遠不是想象的那樣，只有正確的使用才能真正發揮他的作用。

       對於提交更新，建議還是做一點提交一點，當然是在保證代碼沒有錯誤的情況下，這樣方便做恢複更改。找了一點資料，關於更新的原則：

      ①負責而謹慎地提交自己的代碼
      SVN更新的原則是要及時更新，及時提交。當完成了一個小功能，能夠通過編譯並且並且自己測試之後，盡量早的提交，這樣也儲存了曆史版本，必要時候可以復原；在開始一天的工作之前，最後update一下項目。
如果提交過程中產生了衝突，則需要同之前的開發人員聯絡，兩個人一起協商解決衝突，解決衝突之後，需要兩人一起測試保證解決衝突之後，程式不會影響其他功能。
      ②保持原子提交(不要不經意間修改並提交了別人的檔案)
      僅提交你修改的部分，最好不要一下子將整個項目提交；
當完成一個功能或檔案後，最好提交。我就遇到完成某個功能後，沒有提交，後來又做了更改，結果代碼出現bug，無法恢複到正常時的代碼。
      ③不要提交自動產生的檔案
      VisualStudio等開發工具在產生過程中會產生很多自動檔案，如.suo等設定檔，Debug,Release,Obj等編譯檔案，以及其他的一些自動產生，同編譯代碼無關的檔案，這些檔案在提交的時候不應該簽入，如果不小心簽入了，需要從倉庫中刪除。
      ④不要提交不能通過編譯的代碼
      代碼在提交之前，首先要確認自己能夠在本地編譯。進行SVN提交更新時最好是代碼在提交前已經通過自己的測試。
      ⑤不要提交自己不明白的代碼
　　代碼在提交入SVN之後，你的代碼將被項目成員所分享。如果提交了你不明白的代碼，你看不懂，別人也看不懂，如果在以後出現了問題將會成為項目品質的隱患。因此在引入任何第三方代碼之前，確保你對這個代碼有一個很清晰的瞭解。
      ⑥提前宣布自己的工作計劃(多人協作同一個模組的時候)
       在自己準備開始進行某項功能的修改之前，先給工作小組的成員談談自己的修改計劃，讓大家都能瞭解你的思想，瞭解你即將對軟體作出的修改，這樣能儘可能的減少在開發過程中可能出現的衝突，提高開發效率。同時你也能夠在和成員的交流中發現自己之前設計的不足，完善你的設計。
      ⑦對SVN提交更新的資訊採用明晰的標註(類似在代碼裡寫的注釋)
       例如可以採用下列格式
     +)表示增加了功能
     *)表示對某些功能進行了更改
     -)表示刪除了檔案，或者對某些功能進行了裁剪，刪除，屏蔽。
     b)表示修正了具體的某個bug。

 

原文轉自MyException.cn.

 

===================================================

最後, 貼上一個我兩年前的一篇微博, 我覺得, 我當時罵的好機智:

 

Lionden 2015年12月2日

E-mail：[email protected] 

轉載請註明原文地址和部落格園Lionden：http://www.cnblogs.com/lionden/ 

 

【轉】SVN提交一般原則