1、Git代碼提交注釋規(guī)范

需求類Git注釋

需求注釋格式是：需求#{需求ID}：開發(fā)人員填寫的注釋內(nèi)容

例如：需求#123456 API接口開發(fā)和提供

Git命令：

$ git commit -a -m "需求#123456 API接口開發(fā)和提供"

效果類似如下示例：

提交后，需求狀態(tài)自動(dòng)更新為：研發(fā)中、自動(dòng)上屏到需求備注（方便code review）。

問題類Git注釋

格式是：bug#{問題ID}：開發(fā)人員編寫的注釋內(nèi)容或問題原因

例如：bug#123456 這里可以填寫修復(fù)的原因

Git命令：

$  git commit -a -m "bug#123456 這里可以填寫修復(fù)的原因"

效果如下示例：

提交后，問題狀態(tài)自動(dòng)更新為：已解決、自動(dòng)上屏到問題備注（方便code review）、郵件通知問題創(chuàng)建人員并推送釘釘群消息。

上面的需求和Bug提交規(guī)范，可以自動(dòng)和YesDev的需求、Bug進(jìn)行關(guān)聯(lián)。

2、開發(fā)提測新模板

新提測模板請(qǐng)參考：《開發(fā)提測模板》

郵件標(biāo)題：XXXX提測申請(qǐng)

項(xiàng)目鏈接：// 填寫YesDev對(duì)應(yīng)的項(xiàng)目鏈接或需求鏈接

開發(fā)分支：// 粘貼Git倉庫分支鏈接

code review：// 分支對(duì)比鏈接，以及審計(jì)負(fù)責(zé)人

測試環(huán)境：// 填寫測試環(huán)境的域名或APP安裝包鏈接或小程序體驗(yàn)二維碼

開發(fā)人員：// 參與本次開發(fā)的人員名單（可以進(jìn)一步補(bǔ)充每個(gè)模塊的主要負(fù)責(zé)人）

提測內(nèi)容：// 原來的提測內(nèi)容

影響模塊：// 原來的影響模塊

3、線上故障復(fù)盤模板

可以參考YesDev給出的故障復(fù)盤文檔模板進(jìn)行復(fù)盤，包括：故障標(biāo)題、故障描述、故障影響及損失評(píng)估、處理過程、故障原因、后續(xù)改進(jìn)措施等。

4、YesDev協(xié)作流程

1、面向產(chǎn)品經(jīng)理和需求方

如何分類提需求？

1）常規(guī)迭代需求，添加需求或通過Excel導(dǎo)入，由技術(shù)負(fù)責(zé)人 創(chuàng)建項(xiàng)目并進(jìn)行關(guān)聯(lián)需求，評(píng)估工時(shí)，排期開發(fā)

2）緊急需求，需求方/產(chǎn)品經(jīng)理和技術(shù)負(fù)責(zé)人溝通確認(rèn)后，追加需求到已經(jīng)排期的項(xiàng)目中，并且郵件同步發(fā)出

3）專項(xiàng)需求，創(chuàng)建項(xiàng)目后，維護(hù)項(xiàng)目需求，并指派需求給技術(shù)負(fù)責(zé)人

4）小改進(jìn)需求，通過 問題-改進(jìn)，進(jìn)行單獨(dú)提交，非技術(shù)問題，屬于產(chǎn)品需求的小改動(dòng)，例如：修改文案、更換圖片或鏈接等

如何查看最新開發(fā)進(jìn)度？

1）通過項(xiàng)目的詳情頁，查看項(xiàng)目進(jìn)度和需求進(jìn)度

2）在需求詳情頁，通過查看需求的代碼提交記錄，查看開發(fā)動(dòng)態(tài)

3）通過 需求排期，查看當(dāng)前最新的需求排期計(jì)劃和迭代進(jìn)度

4）通過每周的需求KPI郵件《每周需求迭代匯總》定時(shí)接收需求迭代的周記錄，發(fā)送時(shí)間支持可配置

5）通過郵件、釘釘群消息，接收相關(guān)的需求流轉(zhuǎn)新動(dòng)態(tài)，例如：需求已完成、需求已上線等

6）通過釘釘群 【發(fā)布群】上線發(fā)布專用群，接收最終發(fā)布上線的通知，可以和YesDev進(jìn)行集成

7）通過項(xiàng)目排期、提測郵件等，接收項(xiàng)目迭代匯總的信息

2、面向研發(fā)團(tuán)隊(duì)

如何流轉(zhuǎn)需求？

1）根據(jù)需求，評(píng)估開發(fā)任務(wù)、工時(shí)、和預(yù)計(jì)完成的時(shí)間，在每周一之前形成自己的周工作計(jì)劃

2）完成任務(wù)后，及時(shí)將任務(wù)狀態(tài)改為DONE

3）開發(fā)過程中，提交代碼時(shí)，按需求注釋規(guī)范提交Git代碼

4）需求完成或上線后，人工更新需求狀態(tài)為：已完成/已上線

如何流轉(zhuǎn)問題/Bug/故障/工單/改進(jìn)？

1）問題解決后，將問題狀態(tài)改為：已解決，并補(bǔ)充原因

2）問題重開后，重新修復(fù)后，將問題狀態(tài)重新改為：已解決，并補(bǔ)充原因

3）可以按問題注釋規(guī)范，提交Git代碼，會(huì)自動(dòng)更新問題狀態(tài)為：已解決，并通知對(duì)方

4）遇到緊急的故障，應(yīng)立即響應(yīng)并處理，按“先止損-后定位-再排查-改代碼-發(fā)布修復(fù)-最后復(fù)盤”順序處理

如何統(tǒng)籌推進(jìn)項(xiàng)目？

1）進(jìn)行產(chǎn)品需求評(píng)審后，將已確定的需求，創(chuàng)建并關(guān)聯(lián)到指定項(xiàng)目

2）分配需求到技術(shù)人員，各自拆解并評(píng)估任務(wù)和時(shí)間

3）匯總項(xiàng)目排期，發(fā)出項(xiàng)目排期郵件，如有需求，每天或每周或定時(shí)匯總重要項(xiàng)目的進(jìn)度、風(fēng)險(xiǎn)和進(jìn)度

4）關(guān)注每周的項(xiàng)目整體匯總郵件

3、面向測試部門

如何流轉(zhuǎn)開發(fā)過程中發(fā)現(xiàn)的Bug？

1）在指定項(xiàng)目詳情頁，添加新問題到此項(xiàng)目，問題類型選擇：Bug，并指派給技術(shù)人員

2）問題修復(fù)并驗(yàn)收后，將問題狀態(tài)改為：已關(guān)閉，若依然有問題則改為：重開，并填寫原因

如何處理線上故障？

1）發(fā)現(xiàn)故障后，第一時(shí)間在群里同步或現(xiàn)場溝通

2）同步創(chuàng)建故障單，并交給技術(shù)人員在故障處理完畢后補(bǔ)充編寫

如何規(guī)劃測試用例和測試計(jì)劃？

1）可以創(chuàng)建或?qū)霚y試用例

2）可以創(chuàng)建測試計(jì)劃并關(guān)聯(lián)到指定項(xiàng)目

3）在測試計(jì)劃，可以自動(dòng)匯總并整理測試報(bào)告

4）可以定時(shí)接收每周的測試質(zhì)量匯總郵件，跟蹤每周的線上故障、工單等SLA服務(wù)水平

5、技術(shù)文檔編寫規(guī)范

針對(duì)重要的需求、核心功能、以及復(fù)雜的項(xiàng)目，可以按以下技術(shù)文檔模板編寫，以便進(jìn)行技術(shù)評(píng)審。

開發(fā)分支：

// git的倉庫分支

修改范圍：

// 本次修改的頁面、或新增的API接口等

技術(shù)設(shè)計(jì)：

// 核心的UML圖，例如：時(shí)序圖、泳道圖、數(shù)據(jù)模型、架構(gòu)圖、流程圖等

自測結(jié)果：

// 針對(duì)頁面、接口、不同業(yè)務(wù)規(guī)則的自我驗(yàn)證，提供單元測試、鏈接、數(shù)據(jù)庫截圖以及其他材料證明

參考資料：

// 外部參考資料，例如XXX開放平臺(tái)XXX接口