軟件公司-源代碼管理制度

1、源代碼管理制度(討論稿)一、總則 為了加強(qiáng)公司產(chǎn)品、項(xiàng)目開發(fā)源代碼及相關(guān)技術(shù)文檔的管理，進(jìn) 而確保項(xiàng)目實(shí)施的效率和質(zhì)量，特制定本辦法。二、適用范圍 產(chǎn)品、項(xiàng)目開發(fā)技術(shù)人員及項(xiàng)目實(shí)施負(fù)責(zé)人。三、定義 項(xiàng)目：是指通過公司立項(xiàng)確定需要按期實(shí)施的項(xiàng)目。 項(xiàng)目實(shí)施：是指為完成立項(xiàng)項(xiàng)目進(jìn)行的階段性或特定領(lǐng)域的實(shí)施過 程，主要包括研發(fā)實(shí)施和部署實(shí)施。源代碼：是指產(chǎn)品、項(xiàng)目研發(fā)過程中所產(chǎn)生的程序源代碼。 技術(shù)文檔：是指產(chǎn)品、項(xiàng)目配套的各類設(shè)計(jì)文檔、操作手冊等技術(shù)性 文檔。版本管理服務(wù)器： 指公司架設(shè)供所有開發(fā)人員使用的 Subversion(SVN) 服務(wù)器。源代碼提交：指開發(fā)人員通過客戶端程序?qū)⑺帉懺创a

2、上傳至版本 管理服務(wù)器的操作過程。四、源代碼日常管理流程 源代碼管理是技術(shù)研發(fā)過程的日常管理，主要包括源代碼提交、源代碼審閱、異常協(xié)調(diào)等幾個環(huán)節(jié)準(zhǔn)備否五、源代碼結(jié)構(gòu)設(shè)定源代碼結(jié)構(gòu)是指源代碼在版本管理服務(wù)器上存放的文件夾結(jié)構(gòu)源代碼結(jié)構(gòu)的設(shè)定由項(xiàng)目實(shí)施負(fù)責(zé)人決定源代碼結(jié)構(gòu)設(shè)定有幾項(xiàng)基本要求：必須設(shè)置文檔文件夾：每一個獨(dú)立項(xiàng)目或子項(xiàng)目源代碼文件內(nèi)，至少設(shè)定一個 docs或 doc 文件夾以存放僅與該項(xiàng)目相關(guān)技術(shù)文檔 和參考資料；必須考慮支持庫： 源代碼結(jié)構(gòu)中，應(yīng)考慮具體項(xiàng)目所引用的非標(biāo) 第三方支持庫或框架的存放位置；必須可以直接編譯：源代碼結(jié)構(gòu)必須是可直接編譯結(jié)構(gòu)。即任何一臺新裝計(jì)算機(jī)，在安裝了必要

3、的開發(fā)環(huán)境軟件以后，通過從版本管理服務(wù)器上簽出整套源代碼后，應(yīng)該可以直接完成編譯。六、 500 提交500提交是指項(xiàng)目實(shí)施期間，所有參與開發(fā)的技術(shù)人員，每日 5:00 必須將當(dāng)日所編制的源碼或技術(shù)文檔提交至版本管理服務(wù)器。 源代碼及技術(shù)文檔提交有如下幾項(xiàng)要求：任何一次提交都必須對所提交內(nèi)容進(jìn)行注釋； 提交注釋必須包含的信息項(xiàng)包括：所屬模塊或功能（必須與項(xiàng)目 實(shí)施進(jìn)度計(jì)劃一致） 、性質(zhì)（正常開發(fā)、修改 BUG、擴(kuò)展功能）、 狀態(tài)（編碼中（ x%）、調(diào)試通過、獨(dú)測通過、聯(lián)測通過） 、更新說 明（本次提交所涉及修改部分的簡要說明） 。提交注釋必須以下圖示例格式為準(zhǔn)。所提交源碼必須是編譯無錯版本。七、

4、 530 審閱530 審閱是指項(xiàng)目實(shí)施負(fù)責(zé)人，每日下班前審閱版本服務(wù)器上所 有下屬技術(shù)人員所提交的源代碼和技術(shù)文檔。 源代碼審閱有以下幾點(diǎn)審閱標(biāo)準(zhǔn)：下屬技術(shù)人員必須全員按時提交；所有提交必須附有符合要求的提交注釋；各人所提交的內(nèi)容必須與既定的項(xiàng)目實(shí)施進(jìn)度計(jì)劃安排一致；審閱過程中， 凡不符合上述任一條標(biāo)準(zhǔn)的， 則表示當(dāng)日源碼提交 出現(xiàn)異常。 項(xiàng)目實(shí)施負(fù)責(zé)人應(yīng)立即進(jìn)行協(xié)調(diào)， 未按時提交者督促其即 刻提交；沒有附提交注釋或注釋不符合要求者，補(bǔ)充提交注釋；提交 內(nèi)容與既定項(xiàng)目實(shí)施進(jìn)度計(jì)劃安排不一致者， 要進(jìn)行溝通和協(xié)調(diào)， 保 證參與實(shí)施人員的每日工作均按既定計(jì)劃分步實(shí)施。八、 進(jìn)度計(jì)劃更新項(xiàng)目實(shí)施負(fù)責(zé)

5、人， 通過 530 審閱和必要的簡短溝通， 確認(rèn)各在執(zhí) 行子任務(wù)的真實(shí)進(jìn)度，并以此為準(zhǔn)更新進(jìn)度計(jì)劃文檔。九、 版本庫布局版本庫按項(xiàng)目布局， 每一個項(xiàng)目建立一個獨(dú)立的版本庫， 項(xiàng)目版 本庫下設(shè)置 trunk 和 branches 兩個文件夾，分別用于存放原始項(xiàng)目 資料和起源于原始項(xiàng)目的分支項(xiàng)目。每一個項(xiàng)目分支都應(yīng)該有含義明確的命名，并以分支名稱在 branches 文件夾下建立子文件夾。分支文件夾的結(jié)構(gòu)與 trunk 文件 夾結(jié)構(gòu)一致。trunk 文件夾下設(shè)置 working 和 locked 兩個文件夾，其中 working 為工作文件夾， 參與項(xiàng)目的開發(fā)人員有改寫權(quán)限。 locked 文 件

6、夾為定版文件夾， 項(xiàng)目開發(fā)人員無權(quán)訪問， 項(xiàng)目實(shí)施負(fù)責(zé)人有改寫 權(quán)限，品監(jiān)部有簽出權(quán)限。working 文件夾下設(shè)置 docs 和 projects 兩個文件夾， 其中 docs 文件夾存放項(xiàng)目相關(guān)設(shè)計(jì)文檔， projects 文件夾存放各子項(xiàng)目工程 文件夾。docs 和 projects 文件夾以下子文件夾結(jié)構(gòu)不做限定， 但對于 C/S 類項(xiàng)目建議在 projects 文件夾下設(shè)置 server 和 client 兩個文件夾， 分別存放服務(wù)端子項(xiàng)目資料和客戶端子項(xiàng)目資料。十、 項(xiàng)目定版 項(xiàng)目定版是指項(xiàng)目研發(fā)實(shí)施到某個進(jìn)度計(jì)劃中設(shè)定的里程碑狀 態(tài)或其他特定狀態(tài)時， 整體提交的一個階段性版本。

7、一些既定的定版 包括：系統(tǒng)聯(lián)機(jī)調(diào)試定版、內(nèi)測定版、演示定版、實(shí)測定版、發(fā)布定 版、升級定版。對于項(xiàng)目定版有如下要求： 項(xiàng)目所有子項(xiàng)目、子模塊源碼均編譯無錯； 編譯所成系統(tǒng)可聯(lián)機(jī)運(yùn)行； 所有技術(shù)文檔與實(shí)現(xiàn)源碼一致； 項(xiàng)目定版由項(xiàng)目實(shí)施負(fù)責(zé)人組織實(shí)施， 實(shí)施過程在源代碼庫上面 體現(xiàn)為： working 文件夾下最新版本的源碼和文檔被 一次性完整的 提 交到 locked 文件夾。項(xiàng)目定版操作建議：將 locked 文件夾檢出 (Checkout) 一個副本到本地文件夾；將 workingdocs 和 workingprojects 兩個文件夾導(dǎo)出 (Export) 到 locked 副本文件夾，覆

8、蓋 locked 文件夾下的原文件； 提交 (Commit)locked 文件夾；項(xiàng)目定版提交必須附提交注釋，注釋內(nèi)容必須包含的項(xiàng)目包括： 定版目的（聯(lián)機(jī)調(diào)試、內(nèi)測、演示、實(shí)測、發(fā)布、升級） 、版本特性。 其中版本特性要進(jìn)行詳細(xì)說明。 如果是第一個定版， 版本特性應(yīng)詳細(xì) 列舉已經(jīng)實(shí)現(xiàn)的功能， 后續(xù)定版提交注釋的版本特性說明則只需寫明 新版本較上一個版本的新特性。十一、 項(xiàng)目既定定版說明 既定定版是指在項(xiàng)目研發(fā)實(shí)施過程中的必須設(shè)定的幾個階段性 版本。聯(lián)機(jī)調(diào)試定版： 是指項(xiàng)目整體設(shè)計(jì)中的所有子系統(tǒng)和子模塊都已 經(jīng)完成基礎(chǔ)開發(fā)，在研發(fā)實(shí)施團(tuán)隊(duì)內(nèi)部進(jìn)行完整系統(tǒng)聯(lián)機(jī)調(diào)試通 過以后的版本。聯(lián)機(jī)調(diào)試版本中的

9、各個子系統(tǒng)和子模塊不需要完 整實(shí)現(xiàn)了所有既定功能，也不需要達(dá)到既定設(shè)計(jì)性能，可以存在 BUG，其主要作用是為研發(fā)實(shí)施團(tuán)隊(duì)自身構(gòu)建一個可供各功能模塊 進(jìn)行聯(lián)機(jī)調(diào)試的系統(tǒng)環(huán)境，并確認(rèn)系統(tǒng)整體設(shè)計(jì)的可實(shí)施性。聯(lián) 機(jī)調(diào)試定版后，研發(fā)實(shí)施團(tuán)隊(duì)?wèi)?yīng)撰寫系統(tǒng)部署手冊草案 ； 內(nèi)測定版： 是指移交品監(jiān)部進(jìn)行系統(tǒng)測試的版本。內(nèi)測版本應(yīng)該 是通過若干次聯(lián)機(jī)調(diào)試，并且已經(jīng)解決了所有聯(lián)機(jī)調(diào)試過程中所 發(fā)現(xiàn)問題以后的版本。內(nèi)測定版不一定實(shí)現(xiàn)了所有的功能，但已 經(jīng)實(shí)現(xiàn)的功能應(yīng)該具備基本的穩(wěn)定性；演示定版： 是指通過若干次內(nèi)測之后，不存在特別嚴(yán)重缺陷，可 供商務(wù)人員向客戶進(jìn)行產(chǎn)品功能和性能演示的版本。演示定版不 一定實(shí)現(xiàn)了所有的功能，也不一定達(dá)到系統(tǒng)既定設(shè)計(jì)性能。實(shí)測定版： 是指通過若干次內(nèi)測之后，不存在影響正常使用的缺 陷，可供在客戶真實(shí)環(huán)境試用的版本。實(shí)測定版應(yīng)該實(shí)現(xiàn)了所有 核心功能，允許少量存在不確定因素的功能缺失；發(fā)布定版： 是指通過若干次內(nèi)測和實(shí)測之后，已經(jīng)實(shí)現(xiàn)了所有既