資源描述:
《SVN管理規(guī)范》由會(huì)員上傳分享,免費(fèi)在線(xiàn)閱讀,更多相關(guān)內(nèi)容在行業(yè)資料-天天文庫(kù)。
1、1、目的:?本制度為研發(fā)部SVN配置管理的準(zhǔn)則和依據(jù),所有與SVN配置管理的行為都必須遵照并服從于本制度。??2、適用范圍:?本制度適用于研發(fā)部全體員工。???3、控制要求和方法:?3.1?操作流程?首先用戶(hù)從svn版本庫(kù)通過(guò)網(wǎng)絡(luò)“檢出”到本地工作副本中,然后,在本地工作副本中進(jìn)行增加、修改、刪除文件后“提交”到版本庫(kù)中,如果本地工作副本中版本較系統(tǒng)版本過(guò)時(shí),用戶(hù)使用“更新”功能與系統(tǒng)上版本保持一致。?3.2?帳號(hào)注冊(cè)、權(quán)限申請(qǐng)?1.?用戶(hù)帳號(hào)注冊(cè):新進(jìn)員工沒(méi)有SVN帳號(hào),通過(guò)聯(lián)系SVN管理員,注明申請(qǐng)SVN普通帳號(hào)
2、,管理員處理完帳號(hào)注冊(cè)事宜后,通知使用并介紹使用規(guī)范。?????注:普通帳號(hào),只對(duì)目錄有讀取權(quán)限,無(wú)法更改。?2.?權(quán)限的申請(qǐng):?根據(jù)員工所參與的項(xiàng)目,SVN管理員對(duì)其開(kāi)放相應(yīng)目錄的讀、寫(xiě)權(quán)限。????3.?賬號(hào)注銷(xiāo):?jiǎn)T工離職后,對(duì)其賬號(hào)進(jìn)行注銷(xiāo)。?3.3?操作規(guī)范?1.?每日進(jìn)行開(kāi)發(fā)工作之前更新代碼,下班時(shí)提交代碼。?2.?各員工需牢記各自的賬戶(hù)和密碼,不得向他人透漏,嚴(yán)禁使用他人賬戶(hù)進(jìn)行SVN各項(xiàng)操作。?3.?不要簽出整個(gè)目錄,除非特別必要,不應(yīng)同時(shí)簽出過(guò)多的項(xiàng)目。?4.?文件提交時(shí)要求必須提交注釋?zhuān)⒚飨嚓P(guān)修改
3、信息,日志信息描述的越詳細(xì)越好,讓項(xiàng)目組其他成員在看到標(biāo)注后不用詳細(xì)看代碼就能了解你所做的修改。?5.?代碼變動(dòng)及時(shí)提交,避免丟失本地修改后無(wú)法恢復(fù)。?6.?在提交之前要編譯代碼并修正錯(cuò)誤。要保證新增加的文件同時(shí)被提交,否則只在你本地能正常工作,導(dǎo)致其它人不能編譯通過(guò)。?7.?提交之前要測(cè)試所改變的應(yīng)用,測(cè)試改變后的效果是否達(dá)到預(yù)期的目的。?8.?多次檢查提交的內(nèi)容。提交之前應(yīng)先做SVN更新或與資源庫(kù)同步,注意到SVN關(guān)于沖突、錯(cuò)誤的信息。資源庫(kù)同步會(huì)告訴你將要提交的內(nèi)容與資源庫(kù)內(nèi)容之間的差別,確認(rèn)它們是不是你真正想
4、要提交的。?9.?如果別人和自己更改的是同一個(gè)文件,那么Update時(shí)會(huì)自動(dòng)進(jìn)行合并,如果修改的是同一行,那么合并時(shí)會(huì)產(chǎn)生沖突,這種情況就需要同之前的開(kāi)發(fā)人員聯(lián)系,兩個(gè)人一起協(xié)商解決沖突,解決沖突之后,需要兩人一起測(cè)試保證解決沖突之后,程序不會(huì)影響其他功能。?10.?在更新時(shí)注意所更新文件的列表,如果提交過(guò)程中產(chǎn)生了更新,則也是需要重新編譯并且完成自己的一些必要測(cè)試,再進(jìn)行提交。這樣既能了解別人修改了哪些文件,同時(shí)也能避免SVN合并錯(cuò)誤導(dǎo)致代碼有錯(cuò)。?11.?提前宣布修改計(jì)劃。當(dāng)你計(jì)劃進(jìn)行修改,需要影響到SVN里的許
5、多文件時(shí),先通過(guò)郵件或者當(dāng)面通知其他開(kāi)發(fā)者。例如,修改底層數(shù)據(jù)庫(kù)模塊時(shí),有可能影響到業(yè)務(wù)邏輯層調(diào)用數(shù)據(jù)庫(kù)模塊的地方。這樣其他開(kāi)發(fā)者會(huì)有準(zhǔn)備,也會(huì)對(duì)修改提出意見(jiàn)和建議。12.?每次提交盡量是一個(gè)最小粒度的修改。比如一個(gè)小功能提交一次。?13.?不要提交不能通過(guò)編譯的代碼。代碼在提交之前,首先要確認(rèn)自己能夠在本地編譯。如果在代碼中使用了第三方類(lèi)庫(kù),要考慮到項(xiàng)目組成員中有些成員可能沒(méi)有安裝相應(yīng)的第三方類(lèi)庫(kù)。?14.?提交時(shí)注意不要提交本地自動(dòng)生成的文件,提交的文件必須是開(kāi)發(fā)者共用的程序文件,程序編譯中產(chǎn)生的中間文件或文件夾
6、,如/Debug/、/Release/、*.ncb、*.obj、*.o、Thumbs.db、/build/、*.class、/classes/、/data/等不要提交到SVN里。?15.?SVN管理員需對(duì)SVN的所有項(xiàng)目定期備份。?16.?SVN的資料不允許公開(kāi)給其他部門(mén)人員,確實(shí)要分發(fā)的,必須通過(guò)總經(jīng)理同意。?重要說(shuō)明文件要求:?硬件開(kāi)發(fā):?修改日志文件與版本文件(未修改可不寫(xiě)),需求分析書(shū)、源代碼文件、PCB原理圖、料單、技術(shù)規(guī)格書(shū)、生產(chǎn)測(cè)試說(shuō)明書(shū),相關(guān)開(kāi)發(fā)技術(shù)文檔入庫(kù)。?軟件開(kāi)發(fā):?源代碼文件(含數(shù)據(jù)庫(kù)創(chuàng)建腳本
7、(含靜態(tài)數(shù)據(jù)))、編譯構(gòu)建腳本和所有源代碼、修改日志與版本文件,需求分析書(shū)、技術(shù)規(guī)格書(shū)、測(cè)試重點(diǎn)說(shuō)明書(shū)、使用手冊(cè)(包含安裝使用)、使用demo與測(cè)試相關(guān)工具等文件。?測(cè)試部門(mén):?測(cè)試計(jì)劃、測(cè)試用例、測(cè)試bug問(wèn)題單、階段性測(cè)試報(bào)告、問(wèn)題反饋修改單、最終測(cè)試報(bào)告單、版本發(fā)布說(shuō)明書(shū),用戶(hù)手冊(cè)。?以上文件請(qǐng)開(kāi)發(fā)部門(mén)領(lǐng)導(dǎo)與人員督促準(zhǔn)備與提交。