跳至主要内容

将你的代码库提交到 GitHub 社区交流

你可以将你的代码库提交到 GitHub 社区交流,以便其他人查看或参与。

关于代码库提交

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

有三种类型的代码库提交

  • 学习。用于分享分步说明以构建项目的代码库。
  • 协作。用于寻找合作者共同开展项目的代码库。
  • 学习和协作。兼具学习协作的代码库。

在为你的代码库选择提交类型时,请考虑你的代码库的主要目的是什么。

为了推广你的项目并使其更容易被其他学生发现,你应该为你的代码库分配一个或多个主题,并提供 GitHub 学生开发者包。有关更多信息,请参阅“使用主题对你的代码库进行分类”。

一旦将存储库提交到 GitHub Community Exchange,它将立即发布,并带有您选择的用途、主题和优惠。GitHub Community Exchange 社区会审核所有存储库提交。

提交要求

您的存储库必须满足一组最低要求,才能接受提交。在提交过程中,如果所选存储库不满足提交条件,您将收到缺少项的通知。

对于目的为学习的提交,您的存储库必须包含

  • 说明。
  • LEARN.md 文件,提供有关如何构建项目的逐步说明,包括文本和/或媒体。理想情况下,您的 LEARN.md 文件将把项目分解成小组件,并提供每一步的详细说明,以便其他学生可以按照您的说明对他们的项目进行编码。
  • README.md 文件,提供项目的详细说明。
  • 许可证,以便其他人了解他们可以和不可以对您的源代码做些什么。

对于目的为协作的提交,您的存储库必须包含

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

对于学习协作目的来说,一个好的存储库提交是一个遵循社区标准的存储库。有关更多信息,请参阅“关于公共存储库的社区配置文件”。

提交您的存储库

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