Skip to main content

将存储库提交到 GitHub Community Exchange

可将存储库提交到 GitHub Community Exchange,以供其他人查看或参与。

关于存储库提交

只有个人帐户拥有的公共存储库才能提交到 GitHub Community Exchange。

有三种类型的存储库提交:

  • 了解。 用于共享构建项目的分步说明的存储库。
  • 协作。 寻求协作者处理项目的存储库。
  • 了解和协作。 由 LearnCollaborate 组合而成的存储库。

在为存储库选择提交类型时,请考虑存储库的主要用途是什么。

若要提升项目并使其更容易被其他学生发现,你应将一个或多个主题和 GitHub Student Developer Pack 产品/服务分配给存储库。 有关详细信息,请参阅“使用主题对仓库分类”。

将存储库提交给 GitHub Community Exchange 后,它将立即发布,其中包含你所选择的用途、主题和产品/服务。 GitHub Community Exchange 社区审查所有存储库提交。

提交要求

存储库必须满足提交被接受的最低要求。 在提交过程中,如果选择的存储库未满足提交条件,你将收到缺少项的通知。

对于以 Learn 为用途的提交,存储库必须具有:

  • 说明。
  • 一个 LEARN.md 文件,用于通过文本和/或媒体提供有关如何构建项目的分步说明。 理想情况下,LEARN.md 文件会将项目分解为小组件,并提供每个步骤的详细信息,以便其他学生可以按照说明编写其项目。
  • 一个 README.md 文件,用于提供项目的详细说明。
  • 一个许可证,以便其他人知道他们可以和不能用源代码执行的操作。

对于以 Collaborate 为用途的提交,存储库必须具有:

  • 说明。
  • 一个 README.md 文件,用于提供项目的详细说明。
  • 一个许可证,以便其他人知道他们可以和不能用源代码执行的操作。
  • 供协作组处理的一个或多个问题。
  • 用于传达如何参与项目的 CONTRIBUTING.md 文件。

用于 LearnCollaborate 用途的良好存储库提交是遵循社区标准的存储库。 有关详细信息,请参阅“关于公共仓库的社区资料”。

提交存储库

  1. 从 GitHub Education 仪表板,导航到 GitHub Community Exchange 主页。
  2. 在存储库列表上方的搜索和下拉筛选器右侧,单击“添加存储库”。
    一行按钮和下拉菜单的屏幕截图。 “添加存储库”按钮以深橙色框出。
  3. 在弹出窗口中,使用“提交的用途是什么?”下拉菜单并选择一个或多个与提交匹配的条目。
  4. 使用“要使用哪个存储库?”下拉菜单并选择要提交的存储库。 如果未满足提交条件,你将收到有关缺少项的通知,如果想要查看存储库并进行更改以满足条件,则可以单击“编辑存储库”。
  5. 使用“项目使用了哪些产品/服务”下拉菜单并选择一个或多个与提交的内容匹配的条目。
  6. 单击“提交项目”。