跳至主要内容

提交您的仓库至 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 文件,提供对项目的详细描述。
  • 许可证,告知他人对源代码的使用权限和限制。
  • 一个或多个供协作者处理的 Issue。
  • CONTRIBUTING.md 文件,说明如何为您的项目做出贡献。

面向 LearnCollaborate 双重用途的优秀仓库提交应遵循社区标准。了解更多,请参阅 公共仓库的社区配置文件简介

提交您的仓库

  1. 在 GitHub 教育仪表板中,前往 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. 点击 提交项目
© . This site is unofficial and not affiliated with GitHub, Inc.