拉取請求準則

拉取請求 (PR) 是您將程式碼變更提交至某個儲存庫的步驟。若要避免遭受挫折感,您應該務必在動工開始時 提出問題回報以討論任何新功能。如此可以避免您將時間浪費在核心團隊視為不符合專案範圍與目標的功能上。

在判斷功能或是錯誤時,現在該送出拉取請求了。務必在執行步驟時遵循這些步驟,以確保您的程式碼變更盡快交付!

僅觸及相關檔案

確保您的拉取請求專注於單一功能。請勿變更專案設定或與您處理的議題無關的檔案。針對每個議題分別提出一份拉取請求。

確保您的程式碼乾淨俐落

查看專案 風格指南,確保您的程式碼符合規定且乾淨俐落。移除任何偵錯程式碼 (debuggersconsole.log)。

務必針對您的變更進行單元測試

正在加入新的功能嗎?請務必增加單元測試來支援該功能。

修正錯誤嗎?請務必加入能夠重現錯誤的測試。

確保測試通過

我們所有專案的單元測試,只要在專案根目錄輸入 npm test,就能執行。您可能需要安裝依賴項,例如 mochagruntgulp

持續維護您的提交記錄精簡且乾淨俐落

在大型的專案中,維持 git 記錄的精簡與條理十分重要。如此有助於找出錯誤的成因,並能找出最佳的修正方式。

維持記錄的精簡表示針對每個功能新增一筆提交。這也表示團隊審查後,將您在自己分支建立的所有修正進行壓縮。

您是否好奇維持記錄精簡的重要性?請閱讀 Isaac Schlueter (前 Node.js 領導人) 所撰寫的文章。請記住Git 是一種編輯器

具體描述

撰寫關於您的拉取請求的令人信服的描述,並說明我們是否應該保留這項變更。

在進行程式碼審查時堅持下去

維持核心程式碼的精簡與一致性對我們來說十分重要。這表示我們會對程式碼審查採取嚴格的標準!

程式碼審查是我們作為工程師自我提升的最佳途徑。請不要因為這些審查而產生個人觀感:它們旨在維持 Yeoman 的精簡與幫助我們求進步。

請參閱此處,以進一步了解 程式碼審查