我们经常发布文档更新,此页面的翻译可能仍在进行中。有关最新信息,请访问英文文档。如果此页面上的翻译有问题,请告诉我们

Requirements for listing an app

Apps on GitHub Marketplace must meet the requirements outlined on this page before our GitHub Marketplace onboarding specialists will approve the listing.

本文内容

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。

Before you submit your app for review, you must read and accept the terms of the "GitHub Marketplace Developer Agreement." You'll accept the terms within your draft listing on GitHub. Once you've submitted your app, one of the GitHub Marketplace onboarding specialists will reach out to you with more information about the onboarding process, and review your app to ensure it meets these requirements:

User experience

  • GitHub 应用程序s should have a minimum of 100 installations.

  • OAuth 应用程序s should have a minimum of 200 users.

  • Apps must provide value to customers and integrate with the platform in some way beyond authentication.

  • Apps must be publicly available in GitHub Marketplace and cannot be in beta or available by invite only.

  • Apps cannot actively persuade users away from GitHub.

  • Marketing materials for the app must accurately represent the app's behavior.

  • Apps must include links to user-facing documentation that describe how to set up and use the app.

  • When a customer purchases an app and GitHub redirects them to the app's installation URL, the app must begin the OAuth flow immediately. For details, see "Handling new purchases and free trials."

  • Customers must be able to install your app and select repositories on both a personal and organization account. They should be able to view and manage those accounts separately.

Brand and listing

安全

Apps will go through a security review before being listed on GitHub Marketplace. A successful review will meet the requirements and follow the security best practices listed in "Security review process." For information on the review process, contact marketplace@github.com.

Billing flows

Your app must integrate billing flows using the GitHub Marketplace webhook event.

Free apps

GitHub Marketplace 鼓励使用免费应用程序,这是提供开源服务的好方法。 如果您在 GitHub Marketplace 的外部上架了应用程序的付费版本,则您在 GitHub Marketplace 中上架该应用程序时,必须提供至少一个付费计划。 If you are listing a free app, you'll need to meet these requirements:

  • Customers must be able to see that they have a free plan in the billing, profile, or account settings section of the app.
  • When a customer cancels your app, you must follow the flow for cancelling plans.

To offer your app as a paid service, you'll need to meet these requirements to list your app on GitHub Marketplace:

  • To sell your app in GitHub Marketplace, it must use GitHub's billing system. Your app does not need to handle payments but does need to use "GitHub Marketplace purchase events" to manage new purchases, upgrades, downgrades, cancellations, and free trials. See "Billing flows" to learn about how to integrate these events into your app. Using GitHub's billing system allows customers to purchase an app without leaving GitHub and pay for the service with the payment method already attached to their GitHub account.
  • Apps must support both monthly and annual billing for paid subscriptions purchases.
  • Listings may offer any combination of free and paid plans. Free plans are optional but encouraged. For more information, see "Setting a GitHub Marketplace listing's pricing plan."
  • 取消从 GitHub Marketplace 购买的付费计划的客户必须被自动降级到该应用程序的免费计划(如果有)。 当客户取消 GitHub Marketplace 订阅时,GitHub 不会自动卸载应用程序,因此客户可以预期免费功能仍然有效。 强烈建议允许客户重新启用他们以前的计划。
  • 如果您用以下格式提供升级 URL,客户必须能够从应用程序的 UI 升级:https://www.github.com/marketplace/<LISTING_NAME>/upgrade/<LISTING_PLAN_NUMBER>/<CUSTOMER_ACCOUNT_ID>
  • 如果客户购买了席位(单位定价计划)或支持无限协作者的计划,他们必须能够修改哪些用户可以从应用程序的网站访问应用程序。
  • 客户必须能够在应用程序网站的帐单、个人资料或帐户设置部分立即看到其帐户的以下变动:
    • 当前计划和价格。
    • 购买的新计划。
    • 升级、降级、取消以及免费试用剩余天数。
    • 结算周期的变化(每月或每年)。
    • 固定费用和每单位计划的使用情况和剩余资源。 例如,如果定价计划是按单位计费,则应用程序的网站应显示已用单位和可用单位。

此文档对您有帮助吗?

帮助我们创建出色的文档!

所有 GitHub 文档都是开源的。看到错误或不清楚的内容了吗?提交拉取请求。

做出贡献

或, 了解如何参与。