跳到主要内容

将您的仓库提交到 GitHub 社区交流

您可以将您的仓库提交到 GitHub 社区交流,以便其他人查看或参与贡献。

关于仓库提交

只有个人帐户拥有的公共仓库才能提交到 GitHub 社区交流。

仓库提交有三种类型

  • 学习。一个分享构建项目的逐步说明的仓库。
  • 协作。一个寻求协作者参与项目的仓库。
  • 学习与协作。一个结合了学习协作的仓库。

为您的仓库选择提交类型时,请考虑您的仓库的主要用途。

为了推广您的项目并使其更容易被其他学生发现,您应该为您的仓库分配一个或多个主题和 GitHub 学生开发者套件优惠。有关更多信息,请参阅“使用主题对您的仓库进行分类”。

仓库提交到 GitHub 社区交流后,将立即发布您选择的用途、主题和优惠。GitHub 社区交流社区会审核所有仓库提交。

提交要求

您的仓库必须满足最低要求才能被接受。在提交过程中,如果您的选定仓库未满足提交标准,系统会通知您缺少的项目。

对于用途为学习的提交,您的仓库必须具有:

  • 说明。
  • 一个 LEARN.md 文件,提供使用文本和/或媒体的逐步说明,说明您是如何构建项目的。理想情况下,您的 LEARN.md 文件会将您的项目分解成小的组件,并提供每个步骤的详尽细节,以便其他学生可以通过遵循您的说明来编写他们的项目。
  • 一个 README.md 文件,提供项目详细说明。
  • 许可证,以便其他人了解他们可以对您的源代码做什么以及不能做什么。

对于用途为协作的提交,您的仓库必须具有:

  • 说明。
  • 一个 README.md 文件,提供项目详细说明。
  • 许可证,以便其他人了解他们可以对您的源代码做什么以及不能做什么。
  • 一个或多个供协作者处理的问题。
  • CONTRIBUTING.md 文件,说明如何为您的项目贡献代码。

对于学习协作用途而言,良好的仓库提交是一个遵循社区标准的仓库。有关更多信息,请参阅“关于公共仓库的社区配置文件”。

提交您的仓库

  1. 在您的 GitHub 教育仪表盘中,导航到 GitHub 社区交流主页。
  2. 在仓库列表上方,点击搜索和下拉筛选器右侧的**添加仓库**。
    Screenshot of a row of buttons and dropdown menus. The "Add repository" button is outlined in dark orange.
  3. 在弹出窗口中,使用**您的提交的目的是什么?**下拉菜单,选择一个或多个与您的提交匹配的条目。
  4. 使用**您想使用哪个仓库?**下拉菜单,选择您的提交的仓库。如果未满足提交标准,系统会通知您缺少的项目,如果您想查看仓库并进行更改以满足标准,可以点击**编辑您的仓库**。
  5. 使用**您为项目使用了哪些优惠?**下拉菜单,选择一个或多个与您的提交匹配的条目。
  6. 点击**提交项目**。