不再讓開發提交的代碼成爲“黑洞”
在軟件開發過程中,會有一個問題和擔心,就是不知道開發人員提交的代碼質量如何,規範怎樣。更爲讓人痛苦的莫過於當時某個功能需求改了什麼代碼,根本無人知道。
今天,分享一個工具和技巧,讓代碼提交在項目管理中透明化、自動化、可視化。
YesDev敏捷開發團隊的協作工具
YesDev是一款免費的在線協作工具,註冊即可使用,還可以創建和加入多個團隊,非常實用和方便。
讓Git代碼提交自動關聯到需求、Bug和任務,自動上屏
我們先來看下Git代碼提交關聯到需求的效果。產品經理提出需求後,開發人員根據產品需求進行本地開發和提交代碼。根據格式提交Git代碼註釋後,自動上屏的效果類似:
需求彈窗的Git代碼提交記錄
這是一個需求彈窗,在上面可以看到這個需求的內容,以及在右側可以看到當時這個需求由哪位開發人員提交了什麼代碼,包括:修改了哪個代碼倉庫、哪個開發分支、修改時間和commit id,點擊還可以查看對應詳細的代碼修改變更記錄。
點擊查看詳細的代碼修改記錄
在需求詳情頁,可以更直觀地看到代碼提交註釋自動上屏的效果。任務和Bug,與此相似,不再贅述。
自動上屏的Git提交註釋
另一個代碼審查的視角——按功能需求
一個需求,通常需要多名技術人員共同協作,才能一起完成。有了源代碼、任務、需求上線、接口文檔等多元化信息,我們可以在另一個角度更完善地進行代碼審查。
基於Git代碼提交記錄(屬於核心源代碼交付部分),再結合團隊成員在需求備註和討論區提供的接口文檔鏈接,以及任務完成情況的記錄,和需求上線的變更記錄,再結合每個需求的技術文檔、Bug修復,可以更全面、更清晰地知道,當時這個業務需求是誰做的、花了多長時間、具體需求是什麼、以及遇到過哪些坑,一目瞭解,對於維護項目也更有資料參考,不用擔心人員流動而無法接手以前的舊項目、舊系統。
一個需求的詳情頁
通過Git代碼提交自動實現Bug流轉
除了寫代碼、做需求,提Bug和改Bug就是程序員和開發人員日常的另一塊主要工作了。
但有時候,開發人員改好代碼、修復Bug後,沒有及時告訴測試人員,就會導致Bug修復後延長了重新驗收的時間,在溝通和協作上就會出現斷層和延時。
結合YesDev提供的Git代碼提交,就能在開發人員修復bug後自動、實時、第一時間通知測試人員,並且自動將Bug的狀態修改成【已解決】,自動歸因爲【代碼問題】,既在細節提高了工作效率,又在溝通上更爲流暢,又不需要額外使用太多工具。
來看以下的例子。
首先,測試人員創建一個新Bug並指派給開發人員。
一個bug例子
隨後,開發人員在本地修改代碼並修復此問題,同時按規範提交了Git代碼。
代碼修復記錄
接着,測試人員會實時收到bug已解決的反饋和郵件通知(不需要開發人員再人工告知)。
郵件通知
與此同時,在釘釘羣/企業微信羣/飛書羣等,項目干係人也可以同步接收收到bugfix的周知和通知,方便關注這個bug的其他成員第一時間同步收到這個消息。
釘釘羣通知
不僅如此,系統還會智能地將Bug的狀態改爲【已解決】,同時把問題歸因爲改爲【代碼錯誤】。
輕鬆集成現有的Git代碼託管平臺
通過Webhooks,可以讓YesDev項目協作工具與你團隊使用的Git版本管理平臺進行集成,進行及時、自動化的對接,提升工作效率。
目前,YesDev已經支持:
- Gitlab
- Gitee碼雲
- Gitee企業版
- Codeup
- Github
- TFS
等Git的WebHook配置。配置方式如下。
登錄YesDev後,點擊左上角圖標-切換團隊-點擊團隊名稱,獲取你團隊在YesDev的WebHook回調地址。
獲取你的webhook地址
例如,在Gitlab爲你的代碼倉庫添加Webhook,類似:
Gitlab的webhook配置
在Codeup雲效添加Webhook的方法如下。其他Git平臺類似,如果找不到,請先確保有倉庫的管理員權限。
雲效的webhook配置
Git提交註釋規範與格式
目前,YesDev推薦的註釋規範,主要分爲三類:需求註釋規範、Bug註釋規範、任務註釋規範。
- 需求註釋規範:用於實現功能類的開發所進行的提交
- Bug註釋規範:用於進行bugfixed、缺陷修復、故障處理等的代碼修改和提交
- 任務註釋規範:用於進行開發調試、和任務關聯的代碼修改和提交
在開發和實現產品功能時,通過統一的註釋規範,可以和YesDev的需求進行關聯。需要遵循以下注釋提交規範。
需求註釋格式是:
需求#{需求ID}:開發人員填寫的註釋內容
其中,{需求ID}對應YesDev的需求ID,註釋示例:
需求#666:首頁靜態頁面開發
溫馨提示,比原來的git註釋,只是在前面多了關聯的需求ID,很是方便。
另外,Bug和任務的規範,與需求類似,不再展開。
開發人員的代碼提交記錄和分類統計
有了git代碼提交規範後,就可以在YesDev統計每個有的代碼提交記錄。
在Git,也可以看到更專業、更有參考價值的提交記錄。可以知道每一次代碼修改,背後的目的和作用是什麼。