ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

アプリケーションのリストのための要件

GitHub Marketplace上のアプリケーションは、弊社のGitHub Marketplaceオンボーディングスペシャリストがリストを承認する前に、このページに記載されている要件概要を満たしていなければなりません。

ここには以下の内容があります:

レビューのためにアプリケーションをサブミットする前に、「GitHub Marketplace開発者契約」の条項を読んで同意しなければなりません。 GitHub上のドラフトリスト内の条項に同意しなければなりません。 アプリケーションをサブミットすると、オンボーディングプロセスに関するさらなる情報と共にGitHub Marketplaceオンボーディングスペシャリストの一人から連絡があり、アプリケーションをレビューして以下の要件を満たしていることを確認してくれます。

ユーザー体験

  • GitHub Appは、最低でも100個のインストールが必要です。

  • OAuth Appは最低200ユーザが必要です。

  • アプリケーションは顧客に価値を提供し、認証以外の方法でプラットフォームと統合されていなければなりません

  • アプリケーションケーションはGitHub Marketplaceで公開されなければならず、ベータや招待のみでの利用であってはなりません。

  • アプリケーションはユーザをGitHubから積極的に離れさせるようにしてはなりません。

  • アプリケーションのマーケティング資料は、アプリケーションの動作を正確に表現していなければなりません。

  • アプリケーションは、アプリケーションのセットアップと利用の方法を述べたユーザ向けのドキュメンテーションへのリンクを含まなければなりません。

  • 顧客がアプリケーションを購入し、GitHubがそのユーザをアプリケーションのインストールURLにリダイレクトしたなら、アプリケーションはすぐにOAuthフローを開始しなければなりません。 詳細については「新規購入や無料トライアルの取り扱い」を参照してください。

  • 顧客はアプリケーションをインストールし、個人及びOrganization双方のアカウント上のリポジトリを選択できなければなりません。 顧客はそれらのアカウントを個別に表示及び管理できなければなりません。

ブランドとリスト

  • GitHubを使うアプリケーションは、「GitHub ロゴと利用」ガイドラインに従わなければなりません。
  • アプリケーションは、「GitHub Marketplaceリストの説明の作成」にある推奨事項を満たすロゴ、機能カード、スクリーンショット画像を持っていなければなりません。
  • リストには、十分に書かれた文法上の誤りがない説明が含まれていなければなりません。 リストの作成のガイダンスとしては、「GitHub Marketplaceリストの説明の作成」を参照してください。

セキュリティ

アプリケーションは、GitHub Marketplaceにリストされる前にセキュリティレビューを経ることになります。 レビューが成功するためには、「セキュリティレビュープロセス」にリストされている要件を満たし、セキュリティのベストプラクティスにしたがっていなければなりません。 レビュープロセスに関する情報については、marketplace@github.comまでお問い合わせください。

支払いのフロー

アプリケーションは、GitHub Marketplace webhookイベントを使って支払いフローを統合していなければなりません。

無料アプリケーション

無料アプリケーションはGitHub Marketplaceで推奨されており、オープンソースサービスを提供するための素晴らしい方法です。 アプリケーションの有料バージョンをGitHub Marketplace外でリストしているなら、アプリケーションをGitHub Marketplaceでリストする際には最低でも1つの有料プランを提供しなければなりません。無料アプリケーションをリストするなら、以下の要件を満たさなければなりません。

  • 顧客はアプリケーションの支払い、プロフィール、アカウント設定のセクションで、無料プランがあるのを見ることができなければなりません。
  • 顧客がアプリケーションをキャンセルする際には、プランのキャンセルのためのフローに従わなければなりません。

有料アプリケーション

アプリケーションを有料サービスとして提供するためには、GitHub Marketplace上でアプリケーションをリストする上で以下の要件を満たさなければなりません。

  • GitHub Marketplaceでアプリケーションを販売するには、GitHubの支払いシステムを使わなければなりません。 アプリケーションは支払いを処理する必要はありませんが、「GitHub Marketplace 購入イベント」を使って新規の購入、アップグレード、ダウングレード、キャンセル、無料トライアルを管理しなければなりません。 これらのイベントをアプリケーションに統合する方法を学ぶには、「支払いフロー」を参照してください。 GitHubの支払いシステムを使えば、顧客はGitHubを離れることなくアプリケーションを購入し、自分のGitHubアカウントにすでに結合されている支払い方法でサービスに対する支払いを行えます。
  • アプリケーションは、有料のサブスクリプションの購入について、月次及び年次の支払いをサポートしなければなりません。
  • リストは、無料及び有料プランの任意の組み合わせを提供できます。 無料プランはオプションですが、推奨されます。 詳しい情報については「GitHub Marketplaceリストの価格プランの設定」を参照してください。
  • Customers who cancel a paid plan purchased from GitHub Marketplace must be automatically downgraded to the app's free plan if it exists. When a customer cancels a GitHub Marketplace subscription, GitHub does not automatically uninstall the app, so the customer can expect that free features will continue to function. It's highly recommended to allow customers to re-enable their previous plan.
  • Customers must be able to upgrade from your app's UI if you provide an upgrade URL in this format: https://www.github.com/marketplace/<LISTING_NAME>/upgrade/<LISTING_PLAN_NUMBER>/<CUSTOMER_ACCOUNT_ID>
  • Customers must be able to modify which users have access to your app from your app's website if they purchased seats (per-unit pricing plan) or the plan offers unlimited collaborators.
  • Customers must be able to see the following changes to their account immediately in the billing, profile, or account settings section of the app's website:
    • Current plan and price.
    • New plans purchased.
    • Upgrades, downgrades, cancellations, and the number of remaining days in a free trial.
    • Changes to billing cycles (monthly or yearly).
    • Usage and remaining resources for flat-rate and per-unit plans. For example, if the pricing plan is per-unit, your app's site should show units used and units available.

Did this doc help you?

Privacy policy

Help us make these docs great!

All GitHub docs are open source. See something that's wrong or unclear? Submit a pull request.

Make a contribution

OR, learn how to contribute.