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

リポジトリにスポンサーボタンを表示する

あなたのオープンソースプロジェクトに対する資金提供のオプションについての認知度を高めるため、リポジトリにスポンサーボタンを追加できます。

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

FUNDING ファイルについて

デフォルトブランチの、リポジトリ内の .github フォルダにある FUNDING.yml ファイルを編集することで、スポンサーボタンを設定できます。 ボタンには、GitHub Sponsors のスポンサード開発者、外部の資金獲得プラットフォーム、またはカスタムの資金獲得 URL を含めることができます。 GitHub Sponsors の詳細は、「GitHub Sponsors について」を参照してください。

外部の資金獲得プラットフォームごとに 1 つのユーザ名、パッケージ名、またはプロジェクト名と、最大 4 つのカスタム URL を追加できます。 GitHub Sponsors には、スポンサード開発者または Organization を最大 4 人追加できます。 追加する場合は、プラットフォームごとに改行し、以下の構文に従ってください:

プラットフォーム構文
CommunityBridgecommunity_bridge: プロジェクト名
GitHub Sponsorsgithub: ユーザ名 または github: [ユーザ名, ユーザ名, ユーザ名, ユーザ名]
IssueHuntissuehunt: ユーザ名
Ko-fiko_fi: ユーザ名
Liberapayliberapay: ユーザ名
Open Collectiveopen_collective: ユーザ名
Otechieotechie: ユーザ名
Patreonpatreon: ユーザ名
Tidelifttidelift: プラットフォーム名/パッケージ名
カスタム URLcustom: リンク 1 または custom: [リンク 1, リンク 2, リンク 3, リンク 4]

Tidelift では、platform-name/package-name の構文で、以下のプラットフォーム名を用います:

言語プラットフォーム名
JavaScriptnpm
Pythonpypi
Rubyrubygems
Javamaven
PHPpackagist
C#nuget

以下は FUNDING.yml ファイルの例です:

github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]

注釈: 配列内のカスタム URL に : が含まれる場合、URL を引用符で囲む必要があります。 たとえば、"https://www.paypal.me/octocat" です。

所属する Organization またはユーザアカウント用にデフォルトのスポンサーボタンを作成できます。 詳しい情報については「デフォルトのコミュニティ健全性ファイルを作成する」を参照してください。

資金獲得リンクは、オープンソースプロジェクトが、コミュニティから直接的に資金援助を受ける方法を提供します。 資金獲得リンクをその他の目的、たとえば広告や、政治団体、地域団体、または慈善団体を支援する目的で利用することについて、弊社ではサポートいたしかねます。 あなたが意図する利用方法がサポートされているかについてのご質問は、GitHub Support or GitHub Premium Support にお問い合わせください。

リポジトリにスポンサーボタンを表示する

管理者権限があるユーザなら誰でも、リポジトリのスポンサーボタンを有効化できます。

  1. GitHubで、リポジトリのメインページにアクセスしてください。
  2. リポジトリ名の下で Settings(設定)をクリックしてください。
    リポジトリの設定ボタン
  3. [Features] で [Sponsorships] を選択します。
    [Sponsorships] を有効化するチェックボックス
  4. [Sponsorships] で、[Set up sponsor button] または [Override funding links] をクリックします。
    スポンサーボタンを設定するボタン
  5. ファイルエディタで、FUNDING.yml ファイルにある指示に従って、資金獲得の場所へのリンクを追加します。
    FUNDING ファイルを編集して資金獲得の場所へのリンクを追加する
  6. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。
    変更のコミットメッセージ
  7. コミットメッセージフィールドの下で、コミットを追加を現在のブランチか新しいブランチから選択してください。 If your current branch is the default branch, you should choose to create a new branch for your commit and then create a pull request. 詳しい情報については「新しいプルリクエストの作成」を参照してください。
    コミットブランチのオプション
  8. Propose new file(新規ファイルの提案)をクリックしてください。
    新規ファイルの提案ボタン

参考リンク

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.