Code Review 程序員的寄望與哀傷（下集）
來源：cnblogs.com/wenhx/p/5641766.html
一、流程和規(guī)則 二、執(zhí)行 三、收獲 四、總結(jié)
我們?yōu)槭裁匆菩蠧ode Review呢？我們當(dāng)時面臨著代碼混亂、Bug頻出的狀況。
當(dāng)時我覺得要有所改變，希望能提高產(chǎn)品的代碼質(zhì)量，改善開發(fā)團(tuán)隊面臨的困境。并且我個人在開發(fā)上有很多經(jīng)驗，也希望這些知識能夠在團(tuán)隊內(nèi)傳播。
各種考慮后，我們最后認(rèn)為推行Code Review能改善或解決我們面臨的很多問題。
其次每家公司、每個團(tuán)隊的情況都不太一樣，應(yīng)該根據(jù)公司或團(tuán)隊的實際情況選擇恰當(dāng)?shù)姆桨?，并根?jù)成員的反饋來及時調(diào)整，推動Code Review的實施。
所以，本文是介紹我們公司是如何實施Code Review的，我們是如何解決我們遇到的問題的，希望我們的經(jīng)驗?zāi)芙o大家?guī)硇椭?br>行文倉促，如有遺漏或錯誤，歡迎指正。
一、流程和規(guī)則
由于PR需要有權(quán)限的人確認(rèn)，所以非常適合在這個過程中做Code Review，是否接受或者拒絕就取決于Code Review的結(jié)果。
在支持PR模式的軟件里，每一個PR都有一個新增代碼的對比（diff）界面。
代碼審核者可以在線瀏覽請求合并的新增代碼，并針對有疑問的代碼行添加評論，通過這種方式來實現(xiàn)Code Review。
評論可以被所有有權(quán)限查看倉庫的人看到，每個人都可以回復(fù)任何人的評論，有點像論壇里某個帖子的討論。
這種模式是事后審核，也就是代碼已經(jīng)提交到了中心倉庫，Review過程中頻繁的改動會造成歷史簽入記錄的混亂。
當(dāng)然Git可以采用更改歷史記錄來解決這個問題，由于容易誤操作，我們一般只在基礎(chǔ)類庫這類要求比較嚴(yán)格的項目上實施。
由于Git太靈活了，因此誕生了很多的Git流程，用來規(guī)范Git的使用。
常見的有集中式工作流、功能分支工作流、Gitflow工作流、Forking工作流、Github工作流。[
根據(jù)Baza Flow，我們大部分倉庫只定義了2個主干分支，master和develop。(例外，我們有一個倉庫有3個開發(fā)小組同時進(jìn)行開發(fā)，定義了4個主干分支，目前還比較順暢，再多估計主干分支之間的合并就比較繁瑣了。)
master對應(yīng)生產(chǎn)環(huán)境代碼，所有面向生產(chǎn)環(huán)境的發(fā)布來源都是master分支的代碼。develop則對應(yīng)本地測試環(huán)境的代碼。
絕大多數(shù)情況下，QA（測試）只測試develop分支和master分支的代碼。
我們對主干分支的操作權(quán)限做了限制，只有特定的人才能操作，develop分支是項目開發(fā)Leader和架構(gòu)師，master分支是QA。
有權(quán)限往主干分支合并的成員會按照約定的規(guī)則來執(zhí)行合并，不會合并沒有完成審核的PR。
上面這點其實蠻重要的，所以我們會對有權(quán)限合并的人有特別的約定，在什么情況下才能合并代碼。（見后文PR的說明）
PR的發(fā)起人要主動的推動PR的審核，Leader也會密切關(guān)注PR審核的進(jìn)度，在需要的時候及時介入。
所有的代碼合并到了主干分支之后，都會自動觸發(fā)編譯和本地測試環(huán)境的發(fā)布，QA無需依賴開發(fā)人員編譯的代碼來測試，也無需自己手工操作這些，保證了開發(fā)人員和測試人員的相互獨立。
我們本地測試環(huán)境的發(fā)布包含了數(shù)據(jù)庫和站點的發(fā)布，全自動的，發(fā)布完成以后就是一個可用的產(chǎn)品，有時間這部分也可以分享一下。
就是我們規(guī)定了我們一個任務(wù)的完成被定義為：代碼編寫完成，經(jīng)過自測，提交的PR經(jīng)過審核并且合并到主干分支。
也就是說，所有的代碼被合并到了主干分支之后任務(wù)才算是完成，而被合并到主干分支必須要經(jīng)過Code Review，這是強制的。
Baza Flow 當(dāng)前版本 V0.9 Baza Flow 由 Git Flow 演化而來，Git Flow的開發(fā)模式如下圖所示： 由于我們的托管軟件對于Pull Request的限制，我們對Git Flow做了改動，改動的地方有：
1、每一個大功能我們會創(chuàng)建一個單獨的feature分支，項目開發(fā)人員基于這個單獨的feature分支創(chuàng)建自己的任務(wù)分支。
比如，對于CS 2項目來說，啟動的時候分支的創(chuàng)建是：master -> develop -> feature/v2。
開發(fā)人員應(yīng)該基于這個大特性分支feature/v2來創(chuàng)建自己的任務(wù)分支，比如創(chuàng)建XXXX，可以用一個單獨的分支feature/v2-xxxx。
完成這個任務(wù)以后，立即向上游分支（feature/v2）提交pull request。然后從feature/v2-xxxx 創(chuàng)建自己的下一個任務(wù)分支，比如YYYY編輯 feature/v2-yyyy。
請注意，合并到上游分支的功能必須相對獨立而且是可用的，分支任務(wù)工作量0.5-1個工作日，不宜超過2個工作日，超過2個工作日不向上游合并，需要向團(tuán)隊解釋。
代碼經(jīng)過Review以后，可能會進(jìn)行必要的修改，修改在原分支修改，修改完畢代碼合并進(jìn)上游分支，原分支會定期刪除。
項目組成員在收到合并成功的通知后，請自行從上游大特性分支向下合并到自己當(dāng)前的開發(fā)分支。
提交pull request后創(chuàng)建新任務(wù)分支的時候務(wù)必知會一下相關(guān)配合同事（比如前端的同事），讓他們在新的分支上繼續(xù)開發(fā)。2、對于小功能，預(yù)計在0.5-1個（不超過2個）工作日工作量的開發(fā)任務(wù)，直接基于develop分支創(chuàng)建特性分支即可。 3、在各個分支遇到的bug，請基于該分支創(chuàng)建一個Bug分支。
如果在缺陷跟蹤管理系統(tǒng)上有對應(yīng)的項，命名請使用缺陷跟蹤管理系統(tǒng)的ID，比如BAZABUG-1354 比如這個Bug的分支命名就是bugfix/BAZABUG-1354。
如果在缺陷跟蹤管理系統(tǒng)上沒有對應(yīng)的項，命名請簡短的說明修改內(nèi)容，比如“JX 9df2b01 引用bootstrap css虛擬路徑重寫，避免出現(xiàn)字體無法找到的問題”，分支命名可以是bugfix/miss-font。
完成修改以后提交并推送到中心倉庫然后立即向上游分支提交pull request。
4、發(fā)起pull request以后，請將pull request的鏈接在IM上發(fā)給代碼審核者，以此通知對方及時進(jìn)行審核。
二、執(zhí)行
所以，無論進(jìn)度有多么緊迫，Code Review的過程都一定會做。
所有的問題一定會被提出，只是會根據(jù)進(jìn)度的緊迫程度，以及問題的大小，改動成本，決定問題是現(xiàn)在解決，還是加一個TODO，并記錄在缺陷跟蹤管理系統(tǒng)內(nèi)，以防日后遺忘。
多數(shù)情況下，我們都會要求立即解決，哪怕因此造成了發(fā)布的推遲。
我們深知，其實多數(shù)情況下，現(xiàn)在不解決，日后不知道猴年馬月才能解決。
原因大概有兩點，首先管理層方面了解之前遇到的各種問題，也迫切希望能有所改善，所以從一開始就是支持的態(tài)度。
其次，絕大部分開發(fā)人員覺得在這個過程中能自己能學(xué)習(xí)到東西，并沒有抵觸，遇到很好的意見時大家都還是很高興的。
最后，慢慢的形成了一種氛圍，整個團(tuán)隊都會自覺的維護(hù)它。
附一張我們審核的對話圖，這位童鞋嘗試對系統(tǒng)內(nèi)部散落各地發(fā)業(yè)務(wù)郵件的代碼做一個整理，用一套模式來處理，調(diào)整了3版才定調(diào)，然后修改了很多細(xì)節(jié)才通過了合并，前后大概用一個多星期時間：
原因是，雖然代碼合并的周期變長了，但是由于代碼質(zhì)量提高了，導(dǎo)致Bug變少了，由于Bug引起的返工問題也變少了，因此整體的進(jìn)度其實并沒有延緩。
我個人認(rèn)為對一個成熟的團(tuán)隊其實做Code Review反而會加快整體的項目進(jìn)度，但是手頭上沒有統(tǒng)計數(shù)據(jù)支撐我的觀點。（對于軟件開發(fā)的度量，歡迎有心得的同學(xué)告知我）
加上之前遇到的一些問題，我們總結(jié)了一個說明，目的是減輕Code Review對開發(fā)人員工作的負(fù)擔(dān)，加快PR審核通過的過程。
說明如下：
Pull Request 的說明 任務(wù)完成才能提交PR。
PR應(yīng)該在一個工作日內(nèi)被合并或者被拒絕。
PR在有嚴(yán)重問題（包括但不限于架構(gòu)問題、安全問題、設(shè)計問題），太多問題，或者任務(wù)無效的情況下會被拒絕。
嚴(yán)禁一個PR里面有多個任務(wù)，除非它們是緊密關(guān)聯(lián)的。
PR提交之后只允許針對Review發(fā)現(xiàn)問題再次提交代碼，除非有充足的理由，嚴(yán)禁在同一個PR中再次提交其它任務(wù)的代碼。提交PR時候有一個描述框，內(nèi)容會自動根據(jù)Commit的message合并而成。
切記，如果一次提交的內(nèi)容包含很多Commit，請不要使用自動生成的描述。
請用簡短但是足夠說明問題的語言（理想是控制在3句話之內(nèi)）來描述：你改動了什么，解決了什么問題，需要代碼審查的人留意那些影響比較大的改動。特別需要留意，如果對基礎(chǔ)、公共的組件進(jìn)行了改動，一定要另起一行特別說明。
審核人員邀請原則： \1. 在創(chuàng)建PR時，Reviewers（審核人）一欄里主要填寫“必需審核人”。只有這些人審核都通過，才允許合并。
\2. 除了“必需審核人”外，還有一些其它審核人，我們可以在Description里做為“邀請審核嘉賓”@進(jìn)來。
\3. 主干分支間的合并，如Develop => Master，或Master => Develop等，則需要把整個團(tuán)隊（開發(fā)+QA）都列為“必需審核人”。必須審核人的列表由團(tuán)隊決定，可能包括以下人選：
團(tuán)隊Leader 前端架構(gòu)師（如果有前端代碼改動） （可以授權(quán)） 后端架構(gòu)師（如果有后端代碼改動） （可以授權(quán)） 產(chǎn)品架構(gòu)師 對此PR解決的問題比較熟悉的（之前一直負(fù)責(zé)這部分業(yè)務(wù)的同事） 此PR解決的問題對他影響比較大（比如認(rèn)領(lǐng)的任務(wù)依賴此PR的同事） 其它審核人，包括但不限于： 需要知悉此處代碼改動的人但又不必非要其審核通過的同事
可以從這個PR中學(xué)習(xí)的同事可以授權(quán)指的是，根據(jù)約定，Bug修復(fù)之類的改動，或者影響較小的改動，前端架構(gòu)師和后端架構(gòu)師可以授權(quán)團(tuán)隊內(nèi)的某個資深開發(fā)人員，由這個資深開發(fā)人員代表他們進(jìn)行審核。
主干分支之間的合并，大型Feature的合并，前端架構(gòu)師和后端架構(gòu)師需要參與。上述審核人關(guān)注的視角不太一樣：
團(tuán)隊Leader關(guān)注你是否完成了任務(wù)，前后端架構(gòu)師關(guān)注是否符合公司統(tǒng)一的架構(gòu)、風(fēng)格、質(zhì)量，產(chǎn)品架構(gòu)師從整個產(chǎn)品層面來關(guān)注這個PR。
熟悉此問題的同事可以更好的保證問題被解決，確保沒有引入新問題。
被影響的同事可以及時了解他受到的影響。團(tuán)隊Leader或者產(chǎn)品架構(gòu)師如果覺得PR邀請的審核者不足或者過多，必須調(diào)整為合適的人員，其它同事可以在評論中建議。
三、收獲
原因有幾個，大家知道自己的代碼會被人審核之后寫得會比較認(rèn)真。
理論上代碼質(zhì)量是由整個團(tuán)隊內(nèi)最優(yōu)秀的那個人決定的。
大家也能在Review的過程中學(xué)習(xí)到其它同事優(yōu)秀的編碼。
但是這個我們沒有數(shù)據(jù)統(tǒng)計比較，比較遺憾。
我和QA聊過，他給我的數(shù)據(jù)是在我們的一個新項目每2周一次的大發(fā)布，平均只會發(fā)現(xiàn)1~2個Bug。
這點提高了整個團(tuán)隊的幸福感，大家不用經(jīng)常被火燒眉毛。
新同事通過參與Code Review能很快熟悉團(tuán)隊的規(guī)范。
代碼不會只有個別人了解、熟悉，Bug誰都能改，新功能誰都能做。
對公司來說避免了人員的風(fēng)險，對個人來說比較輕松（誰都能來幫你），可以選自己喜歡的任務(wù)做。
Review的過程中會需要非常多的溝通，多溝通能拉近團(tuán)隊成員的距離。
并且無論級別高低，大家的代碼都是要經(jīng)過Review的，可以在團(tuán)隊內(nèi)營造一個平等的氛圍。
每個成員都可以審查別人的代碼，這很容易激發(fā)他們的積極性。
這些PR一共產(chǎn)生了30040個評論，平均每個PR有4.32個評論，最多的一個PR有239個評論。
參與上述PR評論的同事一共有53位，平均每位同事發(fā)出了539個評論，最多的用戶發(fā)出了5311個評論，最少的發(fā)了1個（剛推行Code Review就離職的同事）。
需要說明一下，只有簡單的問題會通過評論來提出。比較復(fù)雜的，比如涉及到架構(gòu)、安全等方面的問題，其實都會面對面的溝通，因為這樣效率更高。
四、總結(jié)
原因是基于分支的PR流程依賴于大量創(chuàng)建分支，而Git創(chuàng)建一個分支非常的簡單，所以PR模式+Git是一個很好的搭配。
我們在切換到Git之前，也做Code Review，采用的是提交代碼以后把commit的Id發(fā)給相關(guān)同事來審查的流程。
審核通過以后會在缺陷跟蹤管理系統(tǒng)里面評論，QA同事沒見到審核通過的評論就認(rèn)為任務(wù)沒有完成，拒絕進(jìn)行測試。
雖然沒有現(xiàn)在這樣直接方便，但是也還是做起來了。
【墻裂推薦】
最近熱門內(nèi)容回顧? ?#技術(shù)人系列
下方二維碼關(guān)注我
互聯(lián)網(wǎng)草根，堅持分享技術(shù)、創(chuàng)業(yè)、產(chǎn)品等心得和總結(jié)~
看到這里，就點個贊吧 ~
評論
圖片
表情