应用上架要求

GitHub Marketplace 上的应用必须满足本页列出的要求，才能发布上架。

本文内容

注意

本文仅适用于在 GitHub Marketplace 发布应用。有关在 GitHub Marketplace 发布 GitHub Actions 的更多信息，请参阅“在 GitHub Marketplace 发布 Actions”。

在 GitHub Marketplace 上架应用的要求会根据您是想提供免费应用还是付费应用而有所不同。

所有 GitHub Marketplace 上架的要求

GitHub Marketplace 上的所有上架应用都应该是为 GitHub 社区提供价值的工具。提交上架申请时，您必须阅读并接受“GitHub Marketplace 开发者协议”的条款。

所有应用的用户体验要求

所有上架应用都应满足以下要求，无论它们是免费应用还是付费应用。

  • 上架应用不得积极劝说用户远离 GitHub。
  • 上架应用必须包含发布者的有效联系信息。
  • 上架应用必须对应用程序进行相关描述。
  • 上架应用必须指定定价方案。
  • 应用必须为客户提供价值，并以某种方式与平台集成，而不仅仅是身份验证。
  • 应用必须在 GitHub Marketplace 上公开提供，不能处于公开预览版或仅限受邀用户使用，Copilot 扩展除外。
  • 应用必须设置 webhook 事件，以便使用 GitHub Marketplace API 通知发布者任何计划更改或取消。有关更多信息，请参阅“在您的应用中使用 GitHub Marketplace API”。

有关提供良好客户体验的更多信息，请参阅“应用的客户体验最佳实践”。

所有应用的品牌和上架要求

  • 使用 GitHub 徽标的应用必须遵循 GitHub 指南。有关更多信息，请参阅“GitHub 徽标和使用”。
  • 应用必须具有符合“撰写应用上架说明”中提供的建议的徽标、功能卡片和屏幕截图图像。
  • 上架说明必须写得很好，并且没有语法错误。有关撰写上架说明的指导，请参阅“撰写应用上架说明”。

为了保护您的客户，我们建议您也遵循安全最佳实践。有关更多信息，请参阅“GitHub Marketplace 上应用的安全最佳实践”。

免费应用注意事项

GitHub Marketplace 鼓励提供免费应用，这是提供开源服务的好方法。如果您在 GitHub Marketplace 之外列出了付费版本的应用，则在 GitHub Marketplace 上列出该应用时，必须至少提供一个付费计划。

GitHub Copilot 扩展的要求

Copilot 扩展本质上是具有额外对 Copilot Chat 的读取访问权限、与 Copilot API 集成以及与其他 LLM 可选集成的 GitHub 应用。

要发布扩展，它必须由具有已验证创建者状态的组织帐户拥有。有关验证流程或转移应用所有权的更多信息，请参阅“申请组织的发布者验证”。

发布 Copilot 扩展的要求与免费应用的要求相同，但以下例外情况除外

  • 您的扩展必须针对诸如“您可以做什么？”或“列出您的功能”之类的提示提供清晰明了的响应。

  • 只要在上架说明中清楚地说明这一点，您的扩展就可以处于公开预览版。如果您使用的是候补名单，则还必须在说明顶部包含一个注册链接。GitHub 审核团队的成员将加入候补名单，并通过电子邮件联系您的技术负责人，请求访问权限进行测试。

  • 您必须包含两个视频链接，演示以下内容：

    • 一些来自您扩展的示例提示和响应
    • 新用户安装、身份验证并将他们的第一个提示发送到您的扩展

    这些视频对 GitHub 保密，仅用于审核您的上架申请。视频可以简短，您无需对其进行编辑。

  • 您的扩展必须提供稳定可靠的用户体验，并能够执行说明中列出的功能。

  • 您必须为新用户提供一条途径，以便他们能够以最小的摩擦安装、设置和授权您的扩展。如果 GitHub 审核团队无法成功测试您的扩展，则不会批准其发布。

付费应用的要求

要在 GitHub Marketplace 上发布应用的付费计划，您的应用必须由作为已验证发布者的组织拥有。有关验证流程或转移应用所有权的更多信息，请参阅“申请组织的发布者验证”。

如果您的应用已发布，并且您是已验证的发布者，则可以从定价计划编辑器发布新的付费计划。有关更多信息，请参阅“设置上架的定价计划”。

要发布付费应用（或提供付费计划的应用），您还必须满足以下要求：

  • GitHub 应用至少应有 100 个安装。
  • OAuth 应用应至少有 200 个用户。
  • 所有付费应用都必须处理 GitHub Marketplace 购买事件，包括新购买、升级、降级、取消和免费试用。有关更多信息，请参阅下面介绍的“付费应用的账单要求”。

准备好要在 GitHub Marketplace 上发布应用时，必须申请应用上架的验证。

注意

如果您想销售由您的个人帐户拥有的应用，首先需要将应用转移到组织，然后才能申请由该组织创建的上架验证。有关如何将应用转移到组织的信息，请参阅：“提交上架申请”。

付费应用的账单要求

您的应用无需处理付款，但确实需要使用 GitHub Marketplace 购买事件来管理新购买、升级、降级、取消和免费试用。有关如何将这些事件集成到您的应用中的信息，请参阅“在您的应用中使用 GitHub Marketplace API”。

使用 GitHub 的账单 API，客户无需离开 GitHub 即可购买应用，并可以使用已附加到他们在 GitHub 上帐户的付款方式支付服务费用。

  • 应用必须支持付费订阅购买的每月和年度账单。
  • 上架应用可以提供任何组合的免费和付费计划。免费计划是可选的，但建议提供。有关更多信息，请参阅“设置上架的定价计划”。