源代码提交SOP(Git版)
一、原則
1、在維護公共基類、工具類和二方庫等可能影響到其他團隊成員的代碼之前,必須同其他團隊成員討論,達成共識后方可進行維護。
2、嚴格遵守源碼簽入規范,有助于發現代碼漏洞,降低代碼合并風險,降低遠程倉庫代碼的出錯概率,請務必細心、審慎,不要因為時間緊就跳過流程步驟。在保證質量的前提下,進度才有意義。
二、六步提交法
1、開始編碼前,從遠程倉庫pull最近成功構建的代碼(有助于減少代碼合并沖突)。
2、編寫功能代碼和對應的單元測試(若無特殊情況工具類和二方庫必寫單元測試,業務代碼可自行判斷)。
3、本地構建
1)編譯代碼、執行本次commit對應的單元測試、運行代碼,確保單元測試通過,程序運行正常,功能滿足需求;
2)檢查代碼是否符合編碼規范(建議使用靜態代碼檢查工具自動檢查);
3)執行commit預操作,逐行比對每個改動點,檢查代碼邏輯是否符合編碼意圖,注釋是否遺漏;
4)填寫commit信息,注意寫明分支名稱,本次提交關聯的任務或者Bug編號;若有多個內容,應分點說明。建議完成獨立的任務或者修復Bug就commit,盡量避免一個任務多次commit或者一次commit中包含多個任務。
提交信息樣例1:
develop_3.0:1、[TASK QZA-339]Tyson WS Clinet 接入;2、jserver-parent增加ws client依賴包;
提交信息樣例2:
master:1、[BUG QZA-433]足球-重要Tab增加本地緩存;
5)確認commit;
4、二次構建
1)從遠程倉庫pull最新代碼到本地;若沒有代碼更新,可跳過步驟4;
2)若出現沖突,需謹慎合并代碼;若不理解沖突代碼,可叫上代碼作者一起合并;
3)編譯代碼、執行本次commit對應的單元測試、運行代碼,確保單元測試通過,程序運行正常,功能滿足需求;
4)再次commit,比對改動點,填寫commit信息;
5、push代碼。
6、提交代碼自動化構建(若有)
1)自動化工具監聽代碼提交,自動構建代碼,執行單元測試,若構建失敗或者單元測試執行失敗,發消息通知團隊;
2)依據“立即暫停原則”團隊收到失敗通知后,暫停新代碼push,也不允許pull代碼,直到接收到構建成功通知;問題代碼作者需立即解決問題,重新提交。
創作挑戰賽新人創作獎勵來咯,堅持創作打卡瓜分現金大獎總結
以上是生活随笔為你收集整理的源代码提交SOP(Git版)的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: 记一次 .NET 某消防物联网 后台服务
- 下一篇: Prism区域异常问题分析(导航失效?)