代碼管理規範

一、git代碼管理規範

1. 分支管理：
   - master分支為線上穩定代碼分支，一般情況不直接在該分支上進行開發，每次發佈之前，需要使用tag打版本號；
   - develop分支為日常開發分支，開發者在該分支下建立自己的feature分支進行開發，測試通過後合併到develop分支，由負責人進行review進行代碼合併；
   - feature分支為具體開發任務分支，根據開發任務命名，任務完成後合併到develop分支；
2. 提交信息規範：
   - 提交信息需簡明扼要，能夠快速了解到該次提交的目的和修改內容；
   - 提交描述必須包含任務編號，如：bug #12，feature #14；
   - 描述信息遵守約定俗成的習慣，格式一般為： 
     feat：新功能；
     fix：修復bug；
     style： 修改樣式；
     docs：修改文檔；
     test： 增加或修改測試；
3. 合併代碼規範：
   - 在合併代碼前，必須執行rebase操作，確保代碼是基於最新的分支（如：develop）進行合併，減少merge帶來的代碼衝突；
   - 每個合併者都需要進行代碼review，確保代碼無誤；
   - 每個分支、每次合併記得標記version和author等必要信息。

二、代碼版本管理規範

代碼的版本管理是保障代碼安全的基石，因此代碼版本管理規範非常重要。相關的代碼版本管理規範如下：

1. 版本號規範：
   - 發佈正式版本應該採用x.y.z的格式，其中：
     x為大版本號，通常在重大變更發生時才會調整，且x的變更意味着API或主要功能有向後不兼容的變化；
     y為次版本號，一般為增加了新功能，對現有的參數和返回值有增加但向後兼容的變化；
     z為修訂號，一般為bug修復、性能優化以及文檔的修改，對原有API保持向後兼容；
2. Git tag規範：
   - 對於線上穩定版本必須打tag，tag命名應該與版本號命名一致；
   - 在tag名稱中添加前綴v，如：v1.0.0；
3. 歸檔規範：
   - 對於每一次發佈的版本，都需要歸檔保存，包括代碼文件（壓縮文件）、sql文件、配置文件等，方便後期維護；
   - 歸檔的文件需要按照日期和版本號進行命名，例如：2022-01-01-release.v1.0.0.zip。

三、svn代碼管理規範

雖然svn已經逐漸被git替代，但是仍然有部分項目在使用svn。針對svn，相關的代碼管理規範如下：

1. 倉庫規範：
   - 為每個項目單獨創建版本庫；
   - 在版本庫中創建branches（分支）、tags（快照）和trunk（主幹）目錄；
   - 將主幹（trunk）作為日常開發版本，分支（branches）為迭代版本，快照（tags）為發佈版本；
2. 提交規範：
   - 在每一次提交代碼之前，必須先執行更新操作（svn update），並進行代碼衝突檢查；
   - 提交信息需簡明扼要，能夠快速了解到該次提交的目的和修改內容；
   - 每個分支、每次合併記得標記相關信息，確保每個版本都可以追溯代碼貢獻者和版本號等信息；
3. 版本號規範：
   - 發佈正式版本應該採用x.y.z的格式，其中：
     x為大版本號，通常在重大變更發生時才會調整，且x的變更意味着API或主要功能有向後不兼容的變化；
     y為次版本號，一般為增加了新功能，對現有的參數和返回值有增加但向後兼容的變化；
     z為修訂號，一般為bug修復、性能優化以及文檔的修改，對原有API保持向後兼容；

四、代碼管理不規範

如果代碼管理不規範，將會對項目開發和維護帶來嚴重的影響，下面是常見的代碼管理不規範：

1. 沒有規範的版本號：缺乏版本號規範，不能清晰區分版本，不利於問題定位和更新升級；
2. 分支混亂：經常出現分支交叉合併，或者無意義的分支建立，導致混亂不堪；
3. 提交信息不規範：提交信息沒有明確的描述該次修改的內容，無法進行追溯，對代碼質量和開發交流都帶來嚴重影響；
4. 代碼審查不規範：缺乏代碼審查流程，各個開發者的代碼質量、風格不統一，導致代碼的質量參差不齊，代碼的可讀性、可維護性差，不利於團隊合作。

五、代碼管理規範樣本

下面是一份比較完整的代碼管理規範樣本，供各位參考。

https://github.com/k88hudson/git-flight-rules

六、固定資產投資項目代碼管理規範

對於固定資產投資項目代碼管理，需要遵循以下規範：

1. 項目結構規範：
   - 將工程代碼與工程文件分離，代碼不應與IDE及開發工具相關；
   - 工程應該清晰地描述出所有的編譯、構建參數；
   - 項目必須包含文檔和測試。
2. 代碼規範：
   - 注釋規範，每個代碼的方法、變量、類都需要添加必要的注釋說明其用途；
   - 代碼風格規範，統一使用公司開發規範的編碼風格；
   - 代碼安全規範，處理用戶輸入數據時必須考慮安全問題；
3. 版本管理規範：
   - 版本/修訂號規範，升級版本需更新主要功能、bug件的修復及文檔的更新等；
   - 分支創建規範，一般提供兩種分支定製：
     a. 單獨的分支針對新需求而開發的改進版；
     b. 定製版，是針對特定客戶而創建的分支。

七、氣瓶使用安全管理規範

對於氣瓶使用安全管理，需要採取以下代碼管理規範：

1. 編寫規範：
   - 消防設計人員應編寫氣瓶使用與保養標準；
   - 瞬間插接連接器的使用和保養標準；
   - 物理阻隔高限度保護使用和保養標準；
   - 低液位報警器和電接點信號的使用和保養標準。
2. 檢測管理規範：
   - 定期檢驗管理規定，擁有氣瓶的單位或者個人必須按照規定將氣瓶交給具備檢驗檢測資質的檢驗機構進行檢驗；
   - 氣瓶使用機構對氣瓶的日常使用情況要進行跟蹤、記錄，並按時上報。
3. 維護保養規範：
   - 在存儲、搬運、運輸和使用過程中嚴格執行相關要求，切勿違章操作；
   - 保養氣瓶必須要由操作工採用合適的儀器、工具進行，切勿折彎、撞擊氣瓶等危險行為。

八、手術室管理規範最新版

對於手術室管理規範，需要做好以下代碼管理工作：

1. 記錄管理規範：
   - 病歷資料要做到觀察完整、檢查清楚、內容準確、記錄規範；
   - 微量製劑要按照製劑規範、製劑記錄的要求來執行，確保製劑過程中藥品數量和藥品質量符合標準。
2. 重點項目監管管理規範：
   - 手術實施規範，手術室負責人要認真維護手術規範、操作規範、清潔衛生衛生管理要求；
   - 職業健康監測規範，審查進門材料，核實相關信息，拒絕登記哪些不符合要求，確保醫療安全；
   - 備貨管理規範，對於高風險物品，必須要有較為完善的備貨管理流程以留下證據。
3. 設備管理規範：
   - 非一次性跟蹤器材要分類存放、細化管理，嚴格按照相應流程進行歸還報廢等。
   - 設備保養、維修人員要為確保數值準確、操作順利和確保安全負責。