硬件研發(fā)部SVN庫管理規(guī)范

1、XXXXxxxx科技有限公司硬件研發(fā)部 SVN版本庫管理規(guī)范硬件研發(fā)部2014/8/8制定初審終審內(nèi)部資料1 總則目的：規(guī)范目前硬件設(shè)計(jì)、固件設(shè)計(jì)、機(jī)械設(shè)計(jì)、項(xiàng)目管理、項(xiàng)目支撐等相關(guān)人員對(duì)SVN的操作。SVN雖然能幫助我們的團(tuán)隊(duì)更有效地協(xié)作，但是如果使用不當(dāng)，它不僅沒給我們帶來任何的方便，反而會(huì)降低我們的工作效率，因此編寫此規(guī)范，目的是方便大家的工作。適用范圍：硬件研發(fā)部全體員工、后續(xù)可能對(duì)關(guān)聯(lián)部門(生產(chǎn)部、品質(zhì)部、采購(gòu)部)的部分版本庫的部分權(quán)限開放。2 SVN概述隨著項(xiàng)目的規(guī)模越來越大，以前靠郵件傳送修改代碼的方式顯得捉襟見肘了，已經(jīng)嚴(yán)重影響了我們的工作效率。SVN全稱是Subversion

2、，是一種版本控制系統(tǒng)，可以給團(tuán)隊(duì)開發(fā)項(xiàng)目時(shí)帶來很多好處：l 它給團(tuán)隊(duì)提供了一個(gè)項(xiàng)目級(jí)別的撤銷功能，沒有什么是最終確定了的，錯(cuò)誤可以很容易被回滾。即無論團(tuán)隊(duì)成員什么時(shí)候所做的修改，都可以撤銷；l 它使得多個(gè)程序員可以有序地同時(shí)為同一個(gè)程序?qū)懘a。團(tuán)隊(duì)不再會(huì)因?yàn)槟橙烁采w了其他團(tuán)隊(duì)成員所做的編輯而丟失做過的工作；l 版本控制系統(tǒng)記錄著每時(shí)每刻的改動(dòng)。如果你遇到了一些修改過的代碼時(shí)，要找到是誰何時(shí)寫的就會(huì)很方便，還可以通過日志了解為什么要這樣寫；l 版本控制系統(tǒng)可以讓你能夠保持主線開發(fā)進(jìn)行的同時(shí)發(fā)布多個(gè)版本。有了版本控制系統(tǒng)，就無須在發(fā)布之前讓團(tuán)隊(duì)停止工作以凍結(jié)代碼了；l 版本控制系統(tǒng)是一個(gè)項(xiàng)目級(jí)別的

3、時(shí)間機(jī)器，可以讓你輸入一個(gè)日期就可看到項(xiàng)目當(dāng)時(shí)的樣子。3 常規(guī)操作3.1 基本操作流程圖圖1 SVN基本操作流層圖在這里一定注意，在對(duì)已有的版本庫進(jìn)行操作前，一定要先更新后提交，具體注意事項(xiàng)如下：經(jīng)常更新：由于文件可能有多個(gè)人修改，應(yīng)該經(jīng)常更新你的工作拷貝中的文件，這樣能降低發(fā)生沖突的可能性；測(cè)試提交：提交前先在本地進(jìn)行測(cè)試。不允許將有錯(cuò)誤的文件提交到SVN服務(wù)器上；填寫備注：提交時(shí)一定要寫備注：備注有助于其他人（包括三個(gè)月后的你自己）理解你對(duì)文件所做的修改；整體提交：提交文件時(shí)注意要提交一項(xiàng)改動(dòng)所對(duì)應(yīng)的所有文件，不要一次提交一個(gè)文件或者一次提交修改了很多功能的一堆文件。3.2 沖突沖突的解決

4、注意事項(xiàng)：目前根據(jù)部門人員規(guī)模及項(xiàng)目規(guī)模，盡量避免多人在同一時(shí)間對(duì)同一個(gè)文檔進(jìn)行編輯的情況，目前最可能出現(xiàn)沖突的情況有兩種：1 因?yàn)檐浖陨碓颍淖兞藗€(gè)別記錄性質(zhì)的文件(如allegro的.jrl文件)，并不是出于自身想編輯文檔的意愿；2 忘記更新而直接編輯協(xié)同工作的文檔，比如同一個(gè)使用說明書，A員工修改提交后，B員工忘記更新直接修改提交。對(duì)于第一種情況，選擇SVN還原(revert)放棄自己的修改即可，如下圖2所示。關(guān)于避免沖突的幾點(diǎn)建議：1） 修改文件之前，先進(jìn)行一次update操作；2） 修改完成后，及時(shí)commit，不要在本地停留過長(zhǎng)時(shí)間；3） 在多位團(tuán)隊(duì)成員協(xié)作時(shí)，盡量修改自己撰寫

5、的部分，盡量不要修改不屬于自己撰寫的部分；4） 出現(xiàn)沖突很正常，可以通過前面的方法解決，不要相互覆蓋。圖2 SVN還原操作3.3 文件檢出安裝TortoiseSVN后，SVN會(huì)跟Windows的資源管理器完美集成。點(diǎn)擊右鍵，我們可以在菜單欄中選擇“SVN檢出”選項(xiàng)，輸入要檢出代碼的文件庫的URL地址，我們就可以檢出該URL地址下的文件庫的文件。默認(rèn)情況下是檢出最新版本的代碼，如果需要，我們可以通過瀏覽日志，根據(jù)日志來找出想要的版本，然后在“版本”選項(xiàng)中指定相應(yīng)版本就可以檢出相關(guān)代碼了。之后，對(duì)于同一個(gè)項(xiàng)目的主干開發(fā)，我們都在這個(gè)檢出的代碼文件目錄下操作，而不是每一次提交或更新都重新檢出一次。3

6、.4 文件添加我們?cè)诒镜貏?chuàng)建的文件(包括目錄)不會(huì)受SVN的控制，為了讓其接受SVN的控制必須將其添加到文件庫中。對(duì)于團(tuán)隊(duì)其他成員需要的文件，如代碼文件、某些模塊的.a文件（由于某些需要，該模塊代碼不公開），我們必須讓它們接受SVN的控制，并且保持最新的版本。3.5 文件刪除當(dāng)我們需要?jiǎng)h除無用的文件(包括目錄)時(shí)，不能使用Windows的資源管理工具，而必須使用SVN本身的刪除文件功能。這樣該文件被刪除后，其所有修改歷史仍然保存在SVN服務(wù)器中，以后仍然可以獲得該文件的修改歷史。3.6 文件改名當(dāng)我們需要對(duì)文件(包括目錄)進(jìn)行改名的時(shí)，不能使用Windows的資源管理工具，而必須使用SVN本身

7、的文件改名功能。這樣該文件被改名后，其改名前的所有修改歷史仍然保存在SVN服務(wù)器中，保持連續(xù)的修改信息。3.7 文件更新其他團(tuán)隊(duì)成員提交到SVN上的改動(dòng)不會(huì)自動(dòng)更新到你的本地拷貝中來，我們需要通過更新文件操作來獲取其他成員對(duì)項(xiàng)目文件所做的修改。SVN更新文件操作會(huì)把文件庫里的文件與本地文件進(jìn)行合并，從而達(dá)到了同時(shí)保留其他成員的修改及本地的修改的目的。如果無法自動(dòng)合并則會(huì)發(fā)生沖突，需要使用文件比較工具進(jìn)行手工合并，合并完成后才能提交已解決沖突的文件。在團(tuán)隊(duì)開發(fā)時(shí)，更新是一件很重要的工作，可以保持團(tuán)隊(duì)成員之間的工作內(nèi)容一致，因此要注意經(jīng)常更新自己的工作拷貝，以保證自己能夠獲得最新的修改內(nèi)容。3.8

8、 改動(dòng)提交我們對(duì)文件(包括目錄)所做的一切改動(dòng)，包括添加、刪除、修改文件都必須提交到SVN服務(wù)器文件庫中才能正式生效，之后團(tuán)隊(duì)的其他成員才可以獲取你所作的修改。提交是很重要的一項(xiàng)操作，要求做到：l 提交代碼之前一定要保證修改后的代碼能編譯通過，不能提交編譯不通過的代碼。l 比較修改前及修改后的代碼，把調(diào)試信息或其他不相關(guān)的信息去掉，再次確保提交的代碼是正確的并且提交的是需要提交的文件。l 不要等到修改了很多代碼才提交，而是相關(guān)小功能完成時(shí)就應(yīng)該提交一次。這樣以后發(fā)現(xiàn)問題時(shí)就很容易撤銷有問題的代碼因?yàn)槌蜂N只能針對(duì)一次提交，所以在一次提交里涉及過多的功能是不推薦的。l 提交時(shí)必須填寫log信息，說

9、明這次提交增加了什么功能或者修正了什么bug。這些信息有助于自己和其他團(tuán)隊(duì)成員了解整個(gè)項(xiàng)目的歷史。當(dāng)出現(xiàn)問題時(shí)也方便定位到對(duì)應(yīng)的版本代碼，所以log信息必須足夠詳細(xì)。3.9 發(fā)布提交發(fā)布提交是指一些經(jīng)過評(píng)審?fù)ㄟ^的，可外發(fā)、可量產(chǎn)、可公布的圖紙、說明書、標(biāo)準(zhǔn)等資料。任何“發(fā)布提交”操作都必須由部門主管執(zhí)行。執(zhí)行發(fā)布提交操作時(shí)，一定要配有評(píng)審單和檢查單,兩個(gè)文件才可提交SVN，沒有的需要說明原因附在發(fā)布文件夾內(nèi)。相關(guān)項(xiàng)目人員有讀權(quán)限。3.10 上傳、刪除、修改標(biāo)識(shí)符為規(guī)范統(tǒng)一 南昌 鎮(zhèn)江后續(xù)操作SVN上的要求統(tǒng)一，我們從現(xiàn)在開始統(tǒng)一在南昌SVN提交時(shí)，除了要寫明備注還要按照：SVN 上傳標(biāo)識(shí)符：  add     delte     modify