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

1、技術(shù)部?jī)?nèi)部規(guī)范SVN使用規(guī)范及要求V1.0技術(shù)部?jī)?nèi)部規(guī)范 文檔變更歷史序號(hào)變更說(shuō)明作者版本號(hào)日期1建立初始文檔VI. 02015-07-20目錄 TOC o 1-5 h z HYPERLINK l bookmark6 o Current Document h .引言4 HYPERLINK l bookmark8 o Current Document h 1編寫目的和范圍4 HYPERLINK l bookmark10 o Current Document h 1.2相關(guān)術(shù)語(yǔ)4 HYPERLINK l bookmark12 o Current Document h .使用規(guī)范及要求4 HYPER

2、LINK l bookmark14 o Current Document h SVN賬號(hào)申請(qǐng)及管理4 HYPERLINK l bookmark16 o Current Document h 使用規(guī)范4 HYPERLINK l bookmark18 o Current Document h . SVN具體使用規(guī)范7 HYPERLINK l bookmark20 o Current Document h TortortoiseSVN 使用7 HYPERLINK l bookmark22 o Current Document h Myeclipse 中 SVN 使用規(guī)范7.引言編寫目的和范圍本制度為

3、研發(fā)部SVN配置管理的準(zhǔn)則和依據(jù),所有與SVN配置管理的行為都必須遵照并 服從于本制度。本制度適用于研發(fā)部全體員工。相關(guān)術(shù)語(yǔ).使用規(guī)范及要求SVN賬號(hào)申請(qǐng)及管理.用戶帳號(hào)注冊(cè)：新進(jìn)員工沒有SVN帳號(hào)，通過(guò)郵件聯(lián)系SVN管理員，郵件正文注明 申請(qǐng)SVN普通帳號(hào)，管理員處理完帳號(hào)注冊(cè)事宜后，會(huì)郵件回復(fù)。注：普通帳號(hào)，只對(duì)個(gè)人目錄有讀取權(quán)限。.權(quán)限的申請(qǐng)：根據(jù)員工所參與的項(xiàng)目，SVN管理員對(duì)其開放相應(yīng)目錄的讀、寫權(quán)限。.賬號(hào)注銷：?jiǎn)T工離職后，對(duì)其賬號(hào)進(jìn)行注銷。使用規(guī)范1、使用自己的賬戶和密碼開發(fā)人員進(jìn)行開發(fā)，必須使用自己的賬戶登錄，禁止使用他人賬戶進(jìn)行SVN各項(xiàng)操作。2、不要簽出(SVN Check

4、out)整個(gè)目錄。工作中需要對(duì)項(xiàng)目或解決方案進(jìn)行任何操作時(shí)，應(yīng)使用SVN請(qǐng)求最新代碼或文件。不 要簽出(SVN Checkout)整個(gè)目錄(切記對(duì)整個(gè)項(xiàng)目進(jìn)行更新或提交動(dòng)作)，除非特別必 要，不應(yīng)同時(shí)簽出過(guò)多的項(xiàng)。使用myeclipse進(jìn)行項(xiàng)目更新時(shí)，要使用資源同步，只更新或 提交有需要的代碼。3、先更新(SVN Update),再提交(SVN Commit)每天在進(jìn)行開發(fā)工作之前先更新代碼，下班時(shí)提交可用的代碼。SVN更新的原則是要隨時(shí)更新(SVN Update),隨時(shí)提交(SVN Commit)。當(dāng)完成 了一個(gè)小功能，能夠編譯并且通過(guò)自己測(cè)試之后，謹(jǐn)慎地提交。如果在修改的期間別人也更改了

5、SVN的對(duì)應(yīng)文件，那么Commit就可能會(huì)失敗。如果 別人和自己更改的是同一個(gè)文件，那么Update時(shí)會(huì)自動(dòng)進(jìn)行合并，如果修改的是同一行， 那么合并時(shí)會(huì)產(chǎn)生沖突，這種情況就需要同之前的開發(fā)人員聯(lián)系，兩個(gè)人一起協(xié)商解決沖突， 解決沖突之后，需要兩人一起測(cè)試保證解決沖突之后，程序不會(huì)影響其他功能。在更新時(shí)注意所更新文件的列表，如果提交過(guò)程中產(chǎn)生了更新，則也是需要重新編譯并 且完成自己的一些必要測(cè)試，再進(jìn)行提交。這樣既能了解別人修改了哪些文件，同時(shí)也能避 免SVN合并錯(cuò)誤導(dǎo)致代碼有錯(cuò)。4、多提交(SVN Commit),不要長(zhǎng)時(shí)間簽出(SVN Checkout)項(xiàng)目或解決方案，減少 因多人對(duì)同一文件

6、進(jìn)行操作而產(chǎn)生的文件沖突。每次提交的間歇盡可能地短，以幾個(gè)小時(shí)的開發(fā)工作為宜。例如在更改UI界面的時(shí)候, 可以每完成一個(gè)UI界面的修改或者設(shè)計(jì)，就提交一次。在開發(fā)功能模塊的時(shí)候，可以每完 成一個(gè)小細(xì)節(jié)功能的測(cè)試，就提交一次，在修改bug的時(shí)候，每修改掉一個(gè)bug并且確認(rèn) 修改了這個(gè)bug,也就提交一次。我們提倡多提交，也就能多為代碼添加上保險(xiǎn)。5、不要提交不能通過(guò)編譯的代碼代碼在提交之前，首先要確認(rèn)自己能夠在本地編譯。如果在代碼中使用了第三方類庫(kù)， 要考慮到項(xiàng)目組成員中有些成員可能沒有安裝相應(yīng)的第三方類庫(kù)。開發(fā)人員在準(zhǔn)備項(xiàng)目工作 的時(shí)候，需要考慮到這樣的情況，確保開發(fā)小組成員在簽出(SVN C

7、heckout)代碼之后能 夠在統(tǒng)一的環(huán)境中進(jìn)行編譯。6、每次提交必須書寫明晰的標(biāo)注在一個(gè)項(xiàng)目組中使用SVN,如果提交空的標(biāo)注或者不確切的標(biāo)注將會(huì)讓項(xiàng)目組中其他 的成員感到很無(wú)奈，項(xiàng)目經(jīng)理無(wú)法很清晰的掌握工作進(jìn)度，無(wú)法清晰的把握此次提交的概要 信息。在發(fā)現(xiàn)錯(cuò)誤后也無(wú)法準(zhǔn)確的定位引起錯(cuò)誤的文件。所以，在提交工作時(shí)，要填寫明晰 的標(biāo)注，能夠概要的描述所提交文件的信息，讓項(xiàng)目組其他成員在看到標(biāo)注后不用詳細(xì)看代 碼就能了解你所做的修改。7、提交時(shí)注意不要提交本地自動(dòng)生成的文件例如eclipse中的.classpath文件，Windows生成的縮略圖Thumbs.db,項(xiàng)目編譯生成 的臨時(shí)文件.obj,

8、 .class等等。如果項(xiàng)目中沒有進(jìn)行這方面的配置來(lái)強(qiáng)行禁止提交這樣的文 件，請(qǐng)自覺不要提交這樣的文件。提交了這樣的文件后，別人在更新后就可能與本地的環(huán)境 沖突從而影響大家的工作。8、不要提交自己不明白的代碼代碼在提交入SVN之后，你的代碼將被項(xiàng)目成員所分享。如果提交了你不明白的代碼, 你看不懂，別人也看不懂，如果在以后出現(xiàn)了問題將會(huì)成為項(xiàng)目質(zhì)量的隱患。因此在引入任 何第三方代碼之前，確保你對(duì)這個(gè)代碼有一個(gè)很清晰的了解。9、慎用鎖定功能在項(xiàng)目中要慎用鎖定的功能，在你鎖定了一個(gè)文件之后別人就無(wú)法繼續(xù)修改提交該文 件，雖然可以減少?zèng)_突的發(fā)生率，但是可能會(huì)影響項(xiàng)目組中其他人員的工作。平時(shí)只有在編 輯

9、那些無(wú)法合并的文件（例如圖片文件，flash文件等）時(shí)，才適當(dāng)?shù)牟捎面i定操作。10、標(biāo)記版本對(duì)已經(jīng)成熟穩(wěn)定的版本，可標(biāo)記為“發(fā)布版”，由項(xiàng)目經(jīng)理提交給管理員。管理員將該版 本向技術(shù)支持部成員開放，用于新項(xiàng)目的實(shí)施和現(xiàn)有用戶的升級(jí)維護(hù)。11、管理員需對(duì)SVN管理的所有項(xiàng)目定期備份。版本管理工具可以管理任何類型的文件，但是在軟件開發(fā)過(guò)程中哪些應(yīng)該納入版本管 理，那些不應(yīng)該納入版本管理，還是有些建議需要遵循。.所有源代碼、makefile文件、工程文件需要入軟件庫(kù)。.所有編譯過(guò)程中生成的中間文件和目標(biāo)文件一般不需要加入到版本庫(kù)。.構(gòu)建腳本、測(cè)試腳本、說(shuō)明文件、安裝腳本、設(shè)計(jì)文檔等需要加入到版本庫(kù)。.

10、工程中的用到的圖標(biāo)文件、聲音文件等在編譯、運(yùn)行時(shí)需要的文件要加入到版本庫(kù)中。.第三方源代碼、庫(kù)等開發(fā)、運(yùn)行環(huán)境需要加入到版本庫(kù)。.版本庫(kù)要合理組織目錄，以滿足項(xiàng)目的需求。.避免在版本庫(kù)中多處保存同樣的東西，如果確實(shí)有此需求，可以在一處保存，用一個(gè)項(xiàng) 目級(jí)的工作區(qū)初始化腳本來(lái)實(shí)現(xiàn)3. SVN具體使用規(guī)范TortortoiseSVN 使用主要是針對(duì)doc文檔的使用。Myeclipse中SVN使用規(guī)范1、SVN的行為指南肯定是“先更新，再提交”。因?yàn)楫?dāng)你提交的時(shí)候必須保證你的文件在 team里是最新版本。否則可能會(huì)導(dǎo)致沖突的發(fā)生。2、在更新之前，我們還需要做一步，就是先查看一下，當(dāng)前team里有沒有沖突項(xiàng)。具體操 作為：選擇項(xiàng)目一右擊一team與數(shù)據(jù)庫(kù)資源同步，彈出提示框，是否打開同步資源的窗口 查看資源。這里一般選擇一是。3、之后我們可以看到項(xiàng)目的整體變更信息。文件右上方標(biāo)有藍(lán)色的是其他同事提交上去的 且沒有與我們自己數(shù)據(jù)沖突。這些文件我們可以直接右擊一update更新一下。4、對(duì)于項(xiàng)目中灰色實(shí)心標(biāo)記的是自己修改的且沒有和其他同事沖突的內(nèi)容。右上角是灰色 十字心標(biāo)記的是自己在項(xiàng)目中新增的文件。這兩種文件可以在項(xiàng)目中直接右擊一commit提 交。順便把自己提交的文件寫一個(gè)簡(jiǎn)明扼要的注解。方便以后查看。5、對(duì)于項(xiàng)目中紅色標(biāo)記，則是有沖突的意思。那么我們就需要選擇該沖突文件，點(diǎn)擊查看