維護 Karma

本文檔適用於 Karma 的開發人員。它描述了常見的任務,例如分類或合併 Pull Request。

如果您有興趣為 Karma 貢獻,可以參考貢獻 Karma

我們使用 gitter/karma-runner 討論 Pull Request 和議題,例如「嘿,這很重要,你能看看嗎...」、「我不確定該如何處理這個議題...」。

分類議題 #

每天都會出現新的議題。我們需要識別緊急議題(例如「沒有人可以安裝 karma」),關閉重複的議題,回答問題等。

請參閱 angular/TRIAGING.md 以獲取更多資訊。

當議題或 Pull Request 未分配給任何里程碑時,表示它尚未分類(需要分類)。

合併 Pull Request #

請確保

  • CI 構建是綠色的。
  • 至少有一位所有者(除了您之外)批准了 PR
    • 通過評論「LGTM」或類似內容。
    • 如果只是簡單的文檔更改或錯字修正,可以跳過此步驟。
  • 所有提交都遵循約定
    • 這一點非常重要,因為自動發佈任務依賴於它。
    • 提交被壓縮。每個更改都是一個單獨的提交。
      • 例如,如果 PR 包含兩個更改,例如 fix(web-server): xxx 然後 style(web-server): 缺少分號;它應該是兩個單獨的更改
      • 例如,如果第一個提交是 fix(web-server): 服務二進制檔案,第二個提交是「修復前一個提交中損壞的單元測試」,則應將它們壓縮為一個單獨的提交。
    • 可以要求 Pull Request 的作者修復上述任何問題。

發佈 npm #

適用於具有管理員權限的核心協作者。

  • 使用良好的網路,確保在過程中不會斷線。
  • 確保您與上游主分支同步。
  • echo $GH_TOKEN
  • npm login karmarunnerbot
    • 密碼只有授權的發佈者知道。
  • grunt release 如果發佈失敗,請檢查推送到 github 的 git 標籤狀態。您可能需要刪除一個。

所有權 #

每個專案都有一個或多個所有者(或「維護者」),列在 package.jsonowners 欄位中。通常,所有者具有推送權限。

成為一個插件的維護者並不意味著您不能為其他插件貢獻。事實上,您可以成為多個專案的維護者。重點是要有人熟悉程式碼庫,因此可以更好地決定什麼是好的更改。

成為維護者 #

如果您有興趣成為 Karma 的維護者,可以先從分類議題、審查 Pull Request 開始,並到 gitter/karma-runner 看看。一旦我們看到您在提供幫助,我們就會授予您推送權限。成為維護者不是一種義務。您可以在有時間的時候提供幫助,在沒有時間的時候減少活動。如果您找到新工作並變得忙碌,那也沒關係。

這些都只是建議,是我們發現有助於提高效率的一些方法。沒有什麼是一成不變的。如果您覺得有辦法改進此工作流程,請將您的建議發送到 karma-devs@googlegroups.com