维护者

维护者指南

帮助 Good First Issue 发现、评估并持续展示你仓库中对新贡献者有用的初学者友好工作。

发现

让你的仓库被索引

Good First Issue 目前索引公开 GitHub 仓库和开放的 GitHub 议题。维护者登录后可以直接提交公开仓库;仓库记录创建后,议题爬虫会继续处理开放议题。

让仓库可见

保持仓库公开、活跃,并能在无需私有上下文的情况下从 GitHub 评估。

记录项目基础信息

保持 README、CONTRIBUTING、许可证、本地设置和测试说明足够清晰,让新贡献者能跟随操作。

提交仓库

登录后提交公开仓库。仓库记录创建后,议题爬虫会继续处理开放议题。

议题标签

标记初学者友好议题

当前抓取任务会搜索带有 good first issue 和 help wanted 标签的开放 GitHub 议题。这些标签能提高可发现性,但议题仍需要足够上下文,让首次贡献者可以安全行动。

提供足够上下文,让第一个 pull request 可审查

  • 说明议题为什么重要。
  • 用具体语言描述期望结果。
  • 指出应先查看的文件、包或产品区域。
  • 提供测试命令或手动验证步骤。
  • 说明贡献者是否应在编码前确认范围。

推荐

提升推荐质量

当仓库显示活跃维护,且议题足够小,让新贡献者无需猜测项目方向就能完成时,推荐效果最好。

近期维护

近期提交、回复和分拣活动能帮助贡献者相信仍然可能获得评审。

清晰的议题描述

有上下文、验收标准和设置说明的议题更容易匹配新贡献者。

小而可审查的范围

低风险文档、测试、UI 打磨和小 bug 修复比宽泛设计工作更容易推荐。

健康的贡献循环

可运行测试和及时反馈能减少被放弃的 pull request,让推荐持续有用。

避免看似适合初学者但难以完成的议题

  • 没有维护者近期确认的陈旧议题。
  • 所有权或产品方向不清楚的大功能。
  • 需要私有上下文、凭证或发布权限的任务。
  • 缺少复现说明、设置指南或期望行为的议题。

准备添加仓库了吗?

从本页提交公开 GitHub 仓库,然后通过索引议题和反馈渠道检查你的初学者友好工作如何呈现。