維護者

維護者指南

幫助 Good First Issue 發現、評估並持續展示你倉庫中對新貢獻者有用的初學者友善工作。

發現

讓你的倉庫被索引

Good First Issue 目前索引公開 GitHub 倉庫和開放的 GitHub 議題。維護者登入後可以直接提交公開倉庫;倉庫紀錄建立後,議題爬蟲會繼續處理開放議題。

讓倉庫可見

保持倉庫公開、活躍,並能在無需私有上下文的情況下從 GitHub 評估。

記錄專案基礎資訊

保持 README、CONTRIBUTING、授權、本地設定和測試說明足夠清楚,讓新貢獻者能跟隨操作。

提交倉庫

登入後提交公開倉庫。倉庫紀錄建立後,議題爬蟲會繼續處理開放議題。

議題標籤

標記初學者友善議題

目前抓取任務會搜尋帶有 good first issue 和 help wanted 標籤的開放 GitHub 議題。這些標籤能提高可發現性,但議題仍需要足夠上下文,讓首次貢獻者可以安全行動。

提供足夠上下文,讓第一個 pull request 可審查

  • 說明議題為什麼重要。
  • 用具體語言描述預期結果。
  • 指出應先查看的檔案、套件或產品區域。
  • 提供測試命令或手動驗證步驟。
  • 說明貢獻者是否應在編碼前確認範圍。

推薦

提升推薦品質

當倉庫顯示活躍維護,且議題足夠小,讓新貢獻者無需猜測專案方向就能完成時,推薦效果最好。

近期維護

近期提交、回覆和分流活動能幫助貢獻者相信仍然可能獲得審查。

清楚的議題描述

有上下文、驗收標準和設定說明的議題更容易匹配新貢獻者。

小而可審查的範圍

低風險文件、測試、UI 打磨和小 bug 修復比寬泛設計工作更容易推薦。

健康的貢獻循環

可執行測試和及時回饋能減少被放棄的 pull request,讓推薦持續有用。

避免看似適合初學者但難以完成的議題

  • 沒有維護者近期確認的陳舊議題。
  • 所有權或產品方向不清楚的大功能。
  • 需要私有上下文、憑證或發布權限的任務。
  • 缺少重現說明、設定指南或預期行為的議題。

準備新增倉庫了嗎?

從本頁提交公開 GitHub 倉庫,然後透過索引議題和回饋管道檢查你的初學者友善工作如何呈現。