SVN源代碼管理規(guī)范精

1、1i:CDYWsoftSVN源代碼管理規(guī)范i>n7 s I呂HL n)nvSVN簡(jiǎn)述、E '-rlTX Subversion是一種集中的分享信息的系統(tǒng)，它 的核心是版本庫(kù)，儲(chǔ)靜所有的數(shù)據(jù)，版本庫(kù)按 照文件樹形式儲(chǔ)存數(shù)據(jù)一包括文件和目錄，任 意數(shù)量的客戶端可以連接到版本庫(kù)，讀寫這些 文件。通過(guò)寫數(shù)據(jù)，別人可以看到這些信息； 通過(guò)讀數(shù)據(jù)，可以看到別人的修改。M Subversion會(huì)記錄每一次的更改，不僅針對(duì)文 件也包括目錄本身，包括增加、刪除和重新組 織文件和目錄SVN版本庫(kù)結(jié)構(gòu)X TrunkX BranchesX TagsTRUNKX任何時(shí)候Trunk里包含的都是最新開發(fā)代碼。這

2、里的 代碼將會(huì)工作到你的下一個(gè)主要發(fā)布版本。X據(jù)我所見，幾乎常常人們只使用trunk來(lái)存放他們的 代碼。發(fā)放了一個(gè)版本后繼續(xù)在其上進(jìn)行下一版開 發(fā)。這不好，無(wú)論是對(duì)你還是你的產(chǎn)品。X Trunk應(yīng)該只被用來(lái)開發(fā)將會(huì)成為你的下一個(gè)重要版 本的代碼。不要給trunk加上版本號(hào)和發(fā)布名稱。僅 需要保證trunk在任何時(shí)候都處于“開發(fā)模式” OBRANCHES Release Branches Bug fix branches Experimental branchesRELEASE BRANCHES當(dāng)trunk達(dá)到準(zhǔn)備發(fā)布的階段時(shí)（或者你想凍結(jié)新特色 的添加時(shí)），你應(yīng)該創(chuàng)建一個(gè)release bra

3、nches。 Release branches只是彳爾當(dāng)前trunk的一個(gè)副本o這類branches可 以被單獨(dú)簽出 你也可 以啟動(dòng)branches 和基于此版本的項(xiàng)目。你還可以使用此分支在測(cè)試期 間修復(fù)Bug。這種方式能夠保證trunk繼續(xù)開發(fā)，而不 會(huì)被發(fā)布某個(gè)具體的版本所干擾。因此當(dāng)你準(zhǔn)備發(fā)布 一個(gè)祈版未0,這屛不會(huì)影徐trunk增加薪殆功能。 命名方式：RB-X.XXBUG FIX BRANCHES分支也可以用 于處理trunk或release brarches里發(fā)現(xiàn)的嚴(yán)重 的Bug。當(dāng)某些Bug很復(fù)雜，你不能通過(guò)只提交一次就修復(fù)他 們。因此為了集中精力修正此錯(cuò)誤，你應(yīng)該為此問題創(chuàng)建一

4、 個(gè)新的分io這樣就木會(huì)影響trunk和release branches斫繼 續(xù)進(jìn)行，并且你也不會(huì)因?yàn)榘l(fā)現(xiàn)渤的Bug和測(cè)試而干擾此 Bug的修復(fù)。Bug修復(fù)分支的命名通常遵循下列方式：使用你的缺陷管理 系統(tǒng)分配給此Bug的ID。通常這是一個(gè)數(shù)字Q如：Bug-3391o當(dāng)然，你也可以象其它分支一樣訪問你的Bug分支。EXPERIMENTAL BRANCHES有時(shí)你想將某個(gè)新技術(shù)引進(jìn)項(xiàng)目。這很好，但是你當(dāng)然不想 賭上你的整個(gè)項(xiàng)目。想象一下，你想把你的Web程序從PHP4 改為PHP5o你?；ǘ嗌贂r(shí)間？在這期間你的trunk停止使用？ ft到你把所有到PHP5的轉(zhuǎn)換做完！這是實(shí)驗(yàn)，可能PHP5就像彩

5、虹的另一端一樣離你的程序太遠(yuǎn) 了，你應(yīng)該給他創(chuàng)建一個(gè)分支。你可以在分支里進(jìn)行更改， 如采失敗了，你在當(dāng)前分支仍然有PHP4的代碼。如采失敗了，實(shí)驗(yàn)分支可以拋棄。如采成功，你可以很容易 的蔣套合并到trunk并繼續(xù)你的新技術(shù)0賣恣分支裕名遵循汪 面原則：為其名字加上前綴“TRY/ OXTAGSX標(biāo)簽就像分支一樣備份你的代碼。但是 Tag不被用來(lái)開發(fā)，他們只是用來(lái)標(biāo)記你 代碼的狀態(tài)OTAGSX標(biāo)簽就像分支一樣備份你的代碼。但是 Tag不被用來(lái)開發(fā)，他們只是用來(lái)標(biāo)記你 代碼的狀態(tài)。 Release tags Bug fix PRE and POST tagsRELEASE TAGSM Release

6、 Tags標(biāo)記你版本發(fā)布點(diǎn)的代碼。 Release Tag永遠(yuǎn)是相應(yīng)發(fā)布分支的副本。 Release Tagx命名規(guī)則：“RELZ 前綴加上版本號(hào)。BUG FIX PRE AND POST TAGSX當(dāng)你創(chuàng)建了一個(gè)Bug fix分支，你想標(biāo)記代 碼在BugFix之前和之后的狀態(tài)。這樣你就 浪容易的引用你所做的更改，合并到trunk 或Release branches。X命名規(guī)則：+ “P RE/ 加上 BugID;+ “POST” 加上Bug ID。SVN使用規(guī)范先更新，再提交多提交不要提交不能通過(guò)編譯的代碼 每次提交必須書寫明晰的標(biāo)注提交時(shí)注意不要提交本地自動(dòng)生成的臨 時(shí)文件不要提交自己不明

7、白的代碼 慎用鎖定功能先更碼珥提交SVN更新的原則是要隨時(shí)更新，隨時(shí)提交。當(dāng)完成了一個(gè) 小功能，能夠通過(guò)編譯并且自己測(cè)試之后，謹(jǐn)慎地提交。如果在修改的期間別人也更改了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)行提交。這樣既能了解別人

8、修改了哪些文件，同時(shí)也 能避免SVN合并錯(cuò)誤導(dǎo)致代碼有錯(cuò)。X多提交X每次提交的間歇盡可能地短，以幾個(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)。X代碼在提交之前，首先要確認(rèn)自己能夠 在本地編譯。如果在代碼中使用了第三 方類庫(kù)，要考慮到項(xiàng)目組成員中有些成 員可能沒有安裝相應(yīng)的第三方類庫(kù)。項(xiàng) 目經(jīng)理在準(zhǔn)備項(xiàng)目工作區(qū)域的時(shí)候，需 要考慮到這樣的情況，

9、確保開發(fā)小組成 員在簽出代碼之后能夠在統(tǒng)一的環(huán)境中 進(jìn)行編譯。每次提交必須書寫 明 晰的標(biāo)注m 小 口eg，：w3c在一個(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ì)看代碼就能了解你所做的修改。不耍提交本地自動(dòng)生成的文件M 例如eclipse 中 的.classpath 文件, Windows生成的縮略圖Thumbs.db,項(xiàng)目 編譯生成的臨時(shí)文件obj等等。如果項(xiàng) 目中沒有進(jìn)行這方面的配置來(lái)強(qiáng)行禁止 提交這樣的文件，請(qǐng)自覺不要提交這樣 的文件。提交了這樣的文件后，別人在 更新后就可能與本地的環(huán)境沖突從而影 響大家的工作。不耍提交自己不明白的代碼其代碼在提交入SVN之后，你的代碼將被 項(xiàng)目成員所分享。如果提交了你不明白 的代碼，你看不懂，別人也看不懂，如 果在以后出現(xiàn)了問題將會(huì)成為項(xiàng)目質(zhì)量 的隱患。因此在引入任何第三方代碼之 前，確保你對(duì)這個(gè)代碼有一個(gè)很清晰