SVN使用規(guī)范及要求V1.0

1、技術部內(nèi)部規(guī)范SVN使用規(guī)范及要求V1.0文檔變更歷史序號變更說明作者版本號日期1建立初始文檔張維波V1.02015-07-20目 錄1. 引言41.1 編寫目的和范圍41.2 相關術語42. 使用規(guī)范及要求42.1 SVN賬號申請及管理42.2 使用規(guī)范43. SVN具體使用規(guī)范73.1 TortortoiseSVN使用73.2 Myeclipse中SVN使用規(guī)范781. 引言1.1 編寫目的和范圍本制度為研發(fā)部SVN配置管理的準則和依據(jù)，所有與SVN配置管理的行為都必須遵照并服從于本制度。本制度適用于研發(fā)部全體員工。1.2 相關術語2. 使用規(guī)范及要求2.1 SVN賬號申請及管理 1. 用

2、戶帳號注冊：新進員工沒有SVN帳號，通過郵件聯(lián)系SVN管理員，郵件正文注明申請SVN普通帳號，管理員處理完帳號注冊事宜后，會郵件回復。 注：普通帳號，只對個人目錄有讀取權限。 2. 權限的申請： 根據(jù)員工所參與的項目，SVN管理員對其開放相應目錄的讀、寫權限。 3. 賬號注銷：員工離職后，對其賬號進行注銷。2.2 使用規(guī)范1、使用自己的賬戶和密碼開發(fā)人員進行開發(fā)，必須使用自己的賬戶登錄，禁止使用他人賬戶進行SVN各項操作。2、不要簽出（SVN Checkout）整個目錄。工作中需要對項目或解決方案進行任何操作時，應使用SVN請求最新代碼或文件。不要簽出（SVN Checkout）整個目錄（切記

3、對整個項目進行更新或提交動作），除非特別必要，不應同時簽出過多的項。使用myeclipse進行項目更新時，要使用資源同步，只更新或提交有需要的代碼。3、先更新（SVN Update），再提交（SVN Commit）每天在進行開發(fā)工作之前先更新代碼，下班時提交可用的代碼。SVN更新的原則是要隨時更新（SVN Update），隨時提交（SVN Commit）。當完成了一個小功能，能夠編譯并且通過自己測試之后，謹慎地提交。如果在修改的期間別人也更改了SVN的對應文件，那么Commit就可能會失敗。如果別人和自己更改的是同一個文件，那么Update時會自動進行合并，如果修改的是同一行，那么合并時會產(chǎn)生

4、沖突，這種情況就需要同之前的開發(fā)人員聯(lián)系，兩個人一起協(xié)商解決沖突，解決沖突之后，需要兩人一起測試保證解決沖突之后，程序不會影響其他功能。在更新時注意所更新文件的列表，如果提交過程中產(chǎn)生了更新，則也是需要重新編譯并且完成自己的一些必要測試，再進行提交。這樣既能了解別人修改了哪些文件，同時也能避免SVN合并錯誤導致代碼有錯。4、多提交（SVN Commit），不要長時間簽出（SVN Checkout）項目或解決方案，減少因多人對同一文件進行操作而產(chǎn)生的文件沖突。每次提交的間歇盡可能地短，以幾個小時的開發(fā)工作為宜。例如在更改UI界面的時候，可以每完成一個UI界面的修改或者設計，就提交一次。在開發(fā)功能

5、模塊的時候，可以每完成一個小細節(jié)功能的測試，就提交一次，在修改bug的時候，每修改掉一個bug并且確認修改了這個bug，也就提交一次。我們提倡多提交，也就能多為代碼添加上保險。5、不要提交不能通過編譯的代碼代碼在提交之前，首先要確認自己能夠在本地編譯。如果在代碼中使用了第三方類庫，要考慮到項目組成員中有些成員可能沒有安裝相應的第三方類庫。開發(fā)人員在準備項目工作的時候，需要考慮到這樣的情況，確保開發(fā)小組成員在簽出（SVN Checkout）代碼之后能夠在統(tǒng)一的環(huán)境中進行編譯。6、每次提交必須書寫明晰的標注在一個項目組中使用SVN，如果提交空的標注或者不確切的標注將會讓項目組中其他的成員感到很無奈

6、，項目經(jīng)理無法很清晰的掌握工作進度，無法清晰的把握此次提交的概要信息。在發(fā)現(xiàn)錯誤后也無法準確的定位引起錯誤的文件。所以，在提交工作時，要填寫明晰的標注，能夠概要的描述所提交文件的信息，讓項目組其他成員在看到標注后不用詳細看代碼就能了解你所做的修改。7、提交時注意不要提交本地自動生成的文件例如eclipse中的.classpath文件，Windows生成的縮略圖Thumbs.db，項目編譯生成的臨時文件.obj, .class等等。如果項目中沒有進行這方面的配置來強行禁止提交這樣的文件，請自覺不要提交這樣的文件。提交了這樣的文件后，別人在更新后就可能與本地的環(huán)境沖突從而影響大家的工作。8、不要提

7、交自己不明白的代碼代碼在提交入SVN之后，你的代碼將被項目成員所分享。如果提交了你不明白的代碼，你看不懂，別人也看不懂，如果在以后出現(xiàn)了問題將會成為項目質量的隱患。因此在引入任何第三方代碼之前，確保你對這個代碼有一個很清晰的了解。9、慎用鎖定功能在項目中要慎用鎖定的功能，在你鎖定了一個文件之后別人就無法繼續(xù)修改提交該文件，雖然可以減少沖突的發(fā)生率，但是可能會影響項目組中其他人員的工作。平時只有在編輯那些無法合并的文件（例如圖片文件，flash文件等）時，才適當?shù)牟捎面i定操作。10、標記版本對已經(jīng)成熟穩(wěn)定的版本，可標記為“發(fā)布版”，由項目經(jīng)理提交給管理員。管理員將該版本向技術支持部成員開放，用于

8、新項目的實施和現(xiàn)有用戶的升級維護。11、管理員需對SVN管理的所有項目定期備份。版本管理工具可以管理任何類型的文件，但是在軟件開發(fā)過程中哪些應該納入版本管理，哪些不應該納入版本管理，還是有些建議需要遵循。1. 所有源代碼、makefile文件、工程文件需要入軟件庫。2. 所有編譯過程中生成的中間文件和目標文件一般不需要加入到版本庫。3. 構建腳本、測試腳本、說明文件、安裝腳本、設計文檔等需要加入到版本庫。4. 工程中的用到的圖標文件、聲音文件等在編譯、運行時需要的文件要加入到版本庫中。5. 第三方源代碼、庫等開發(fā)、運行環(huán)境需要加入到版本庫。6. 版本庫要合理組織目錄，以滿足項目的需求。7. 避

9、免在版本庫中多處保存同樣的東西，如果確實有此需求，可以在一處保存，用一個項目級的工作區(qū)初始化腳本來實現(xiàn)3. SVN具體使用規(guī)范3.1 TortortoiseSVN使用主要是針對doc文檔的使用。3.2 Myeclipse中SVN使用規(guī)范1、SVN的行為指南肯定是“先更新，再提交”。因為當你提交的時候必須保證你的文件在team里是最新版本。否則可能會導致沖突的發(fā)生。2、在更新之前，我們還需要做一步，就是先查看一下，當前team里有沒有沖突項。具體操作為：選擇項目-右擊-team-與數(shù)據(jù)庫資源同步，彈出提示框，是否打開同步資源的窗口查看資源。這里一般選擇-是。3、之后我們可以看到項目的整體變更信息。文件右上方標有藍色的是其他同事提交上去的且沒有與我們自己數(shù)據(jù)沖突。這些文件我們可以直接右擊-update更新一下。4、對于項目中灰色實心標記的是自己修改的且沒有和其他同事沖突的內(nèi)容。右上角是灰色十字心標記的是自己在項目中新增的文件。這兩種文件可以在項目中直接右擊-commit提交。順便把自己提交的文件寫一個簡明扼要的注解。方便以后查看。5、對于項目中紅色標記，則是有沖突的意思。那么我們就需要選擇該沖突文件，點擊查看沖突原因。這也分為兩種情況。一，