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

この記事の内容

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

FUNDING ファイルについて

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

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

プラットフォーム構文
LFX Mentorship (旧称 CommunityBridge)community_bridge: PROJECT-NAME
GitHub Sponsorsgithub: USERNAME または github: [USERNAME, USERNAME, USERNAME, USERNAME]
IssueHuntissuehunt: USERNAME
Ko-fiko_fi: USERNAME
Liberapayliberapay: USERNAME
Open Collectiveopen_collective: USERNAME
Otechieotechie: USERNAME
Patreonpatreon: USERNAME
Tidelifttidelift: PLATFORM-NAME/PACKAGE-NAME
カスタム URLcustom: LINK1 または custom: [LINK1, LINK2, LINK3, LINK4]

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 サポート にアクセスしてください。

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

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

  1. GitHub.com で、リポジトリのメイン ページへ移動します。

  2. リポジトリ名の下にある [設定] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウン メニューを選び、 [設定] をクリックします。

    タブを示すリポジトリ ヘッダーのスクリーンショット。 [設定] タブが濃いオレンジ色の枠線で強調表示されています。

  3. [全般] 設定ページの [機能] セクションで、 [スポンサーシップ] を選びます。

  4. [スポンサーシップ] ボックスで、 [スポンサー ボタンの設定] または [資金調達リンクを上書きする] をクリックします。

  5. ファイル エディターで、FUNDING.yml ファイルの指示に従って、資金調達の場所へのリンクを追加します。

  6. [変更のコミット...] をクリックします。

  7. [コミット メッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミット メッセージを入力します。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しくは、「複数の作者を持つコミットを作成する」を参照してください。

  8. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳しくは、「pull request の作成」を参照してください。

    GitHub pull request のスクリーンショット。メイン ブランチに直接コミットする、または新しいブランチを作成するためのラジオ ボタンが表示されています。 新しいブランチが選ばれています。

  9. [変更のコミット] または [変更の提案] をクリックします。

参考資料