錯誤分類和議題整理#

議題追蹤器對於專案中的溝通非常重要：它幫助開發人員找出主要的工作專案，以及討論優先事項。因此，整理它非常重要，需要為議題加上標籤，並關閉不必要的議題。

改善議題#

改善議題可以增加它們成功被解決的機會。關於提交良好議題的指南，請參考此處。第三方可以提供有用的回饋，甚至在議題上添加評論。以下動作通常很有用：

  • 記錄缺少重現問題要素（例如程式碼範例）的議題

  • 建議更好地使用程式碼格式

  • 建議重新調整標題和描述，使其更清楚地說明要解決的問題

  • 連結到相關的議題或討論，同時簡要描述它們的關聯性，例如「另請參閱#xyz，了解類似的嘗試」或「另請參閱#xyz，其中在SomeEstimator中發生了相同的問題」，提供背景資訊並幫助討論。

協助審閱 PR#

也鼓勵審閱程式碼。歡迎貢獻者和使用者按照我們的審閱指南參與審閱流程。

核心團隊和貢獻者體驗團隊成員的分類操作#

除了以上內容，核心團隊和貢獻者體驗團隊的成員還可以執行以下重要任務：

  • 更新議題和 PR 的標籤：請參閱可用的 github 標籤列表。

  • 確定 PR 是否必須重新標記為停滯或需要幫助（這在衝刺期間尤其重要，因為風險是產生許多未完成的 PR）

  • 如果停滯的 PR 被較新的 PR 接管，則將停滯的 PR 標記為「已取代」，在停滯的 PR 上留下評論並連結到新的 PR，並可能關閉停滯的 PR。

  • 分類議題

    • 關閉使用問題，並禮貌地引導回報者改用 Stack Overflow。

    • 關閉重複的議題，在確認它們確實重複後。理想情況下，原始提交者應將討論移至較舊的重複議題

    • 關閉無法重現的議題，在給予時間（至少一週）添加額外資訊後

已儲存的回覆有助於節省時間，同時在分類時保持友善和禮貌。

請參閱 github 說明，了解組織中的角色。

分類議題的典型工作流程#

以下工作流程[1]是處理議題分類的好方法

  1. 感謝回報者開啟議題

    議題追蹤器是許多人第一次與 scikit-learn 專案本身互動，而不僅僅是使用該函式庫。因此，我們希望它成為一個友善、愉快的體驗。

  2. 這是使用問題嗎？如果是，請以禮貌的訊息關閉它（這裡有一個範例）。

  3. 是否提供了必要的資訊？

    如果缺少關鍵資訊（例如使用的 scikit-learn 版本），請隨時要求提供該資訊，並將議題標記為「需要資訊」。

  4. 這是重複的議題嗎？

    我們有很多未解決的議題。如果一個新的議題看起來是重複的，請指向原始議題。如果它是一個明確的重複，或共識認為它是多餘的，請關閉它。確保仍然感謝回報者，並鼓勵他們在原始議題上發聲，並嘗試修復它。

    如果新的議題提供了相關資訊，例如更好或略有不同的範例，請將其作為評論或編輯添加到原始發文中。

  5. 確保標題準確反映了議題。如果它不清楚，請在您有必要的權限時自行編輯。

  6. 議題是否最小且可重現？

    對於錯誤報告，我們要求回報者提供最小的可重現範例。請參閱 Matthew Rocklin 的這篇有用的文章，以獲得良好的解釋。如果範例不可重現，或者它明顯不是最小的，請隨時詢問回報者是否可以提供範例或簡化提供的範例。請理解編寫最小可重現範例是很困難的工作。如果回報者遇到困難，您可以嘗試自己編寫一個。

    如果提供了可重現的範例，但您看到了簡化，請添加您更簡單的可重現範例。

  7. 添加相關標籤，例如當議題與文件相關時添加「文件」，如果它明顯是一個錯誤則添加「錯誤」，如果它是增強請求則添加「增強」...。

    如果議題已明確定義且修復看起來相對簡單，則將議題標記為「適合新手」。

    另一個有用的步驟是在相關時標記對應的模組，例如sklearn.linear_models。

  8. 如果存在「需要分類」標籤，請從議題中移除該標籤。