目標
審核程序有幾個目標:
- 確保功能和易讀性都得到高品質的程式碼。
- 找出錯誤,原因是發生錯誤。
- 維持一致的樣式,讓您輕鬆開始在程式碼集的任何部分開始使用。
進入區塊範例和核心 Blockly 的所有程式碼都會接受審查,無論是由社群貢獻者或 Blockly 團隊成員撰寫。
審查人員會致力協助你做出最完善的變更。 我們希望身為貢獻者的您參與對話,透過審查及合併的方式,獲得您的提取要求。
流程
公關審核程序分為以下幾個階段:
指派項目
收到提取要求時,Blockly 團隊成員會指派審查者。
審查人員會依據專業選擇,並平均分配工作負載。
指派審查者可能需要幾天的時間,審查人員需要幾天的時間才會獲得審查。別擔心,這是正常現象。
意見回饋
在意見回饋階段,審查人員會針對你的公關提交建議。這些簡單的做法可以讓程式碼符合 Google JavaScript 樣式指南的規定。也可能是較大型的項目,例如要求您重新整理函式定義。
我們建議審查人員使用 GitHub 的程式碼審查 (而非個別留言),以便接收單一通知,而非多則通知。
討論
您可以在討論階段回應意見。也許其中一則評論有點不清楚的說法,現在您可以趁這個機會要求說明。或者,也許審查者要求做出變更,但您認為這項變更會受到影響:現在您可以有機會找到漏洞。
修訂版本
你可以在修訂版本階段對公關進行變更。這些變化通常是審查人員在意見回饋階段發表的看法。
完成修訂版本後,您可以為審查者標記,要求他們再次檢查。
重複
在修訂版本階段結束後,審查人員有機會提供意見回饋,整個程序會從頭開始。
第二項審查通常十分簡單,著重在標點符號和程式碼樣式等方面。但有時第二次審查可能十分龐大。第一批評論者甚至可能會要求他人檢查內容,藉此獲得全新觀點。
合併!
合併階段是慶祝的絕佳機會。您建立了一項變更、討論及修改內容,最後成功合併了內容!這是許多人從未開始的成就,單獨完成!
感謝大家的辛勤付出,讓 Blockly 更臻完善。恭喜!