跳至主要内容

列出应用程序的要求

在发布清单之前,GitHub Marketplace 上的应用程序必须满足此页面中概述的要求。

注意: 本文仅适用于在 GitHub Marketplace 中发布应用程序。有关在 GitHub Marketplace 中发布 GitHub Actions 的更多信息,请参阅“在 GitHub Marketplace 中发布操作”。

在 GitHub Marketplace 上列出应用程序的要求取决于您是想提供免费应用程序还是付费应用程序。

所有 GitHub Marketplace 列表的要求

GitHub Marketplace 上的所有列表都应针对为 GitHub 社区提供价值的工具。当您提交您的列表以供发布时,您必须阅读并接受“GitHub Marketplace 开发者协议”的条款。

所有应用程序的用户体验要求

所有列表都应满足以下要求,无论它们是针对免费应用程序还是付费应用程序。

  • 列表不得积极说服用户远离 GitHub。
  • 列表必须包含发布者的有效联系信息。
  • 列表必须包含应用程序的相关描述。
  • 列表必须指定定价计划。
  • 应用程序必须为客户提供价值,并以某种方式与平台集成,而不仅仅是身份验证。
  • 应用程序必须在 GitHub Marketplace 上公开可用,并且不能处于测试版或仅通过邀请可用。
  • 应用程序必须设置 Webhook 事件,以使用 GitHub Marketplace API 通知发布者任何计划更改或取消。有关更多信息,请参阅“在您的应用程序中使用 GitHub Marketplace API”。

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

所有应用程序的品牌和列表要求

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

免费应用的注意事项

GitHub Marketplace 鼓励免费应用,它们是提供开源服务的绝佳方式。如果您在 GitHub Marketplace 之外列出了您的应用的付费版本,则在 GitHub Marketplace 中列出该应用时,您必须至少提供一个付费计划。

付费应用的要求

要在 GitHub Marketplace 上发布您的应用的付费计划,您的应用必须归属于已验证的发布者的组织。有关验证过程或转移应用所有权的更多信息,请参阅“申请组织的发布者验证”。

如果您的应用已发布并且您是经过验证的发布者,那么您可以从定价计划编辑器中发布新的付费计划。有关更多信息,请参阅“为您的列表设置定价计划”。

要发布付费应用(或提供付费计划的应用),您还必须满足以下要求

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

当您准备好将应用发布到 GitHub Marketplace 时,您必须请求验证应用列表。

注意:如果您想出售由您的个人帐户拥有的应用,首先您需要将应用转移到组织,然后请求验证由该组织创建的列表。有关如何将应用转移到组织的信息,请参阅:“提交您的列表以供发布”。

付费应用的计费要求

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

使用 GitHub 的计费 API 允许客户在不离开 GitHub 的情况下购买应用程序,并使用已附加到其 GitHub.com 帐户的付款方式支付服务。

  • 应用程序必须支持付费订阅购买的每月和每年计费。
  • 列表可以提供任何组合的免费和付费计划。免费计划是可选的,但鼓励使用。有关更多信息,请参阅 "为您的列表设置定价计划”。