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

FUNDING ファイルについて

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

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

プラットフォーム	構文

          [LFX Mentorship (旧称 CommunityBridge)](https://lfx.linuxfoundation.org/tools/mentorship) | `community_bridge: PROJECT-NAME`

          [GitHub Sponsors](https://github.com/sponsors) | 
          `github: USERNAME` または `github: [USERNAME, USERNAME, USERNAME, USERNAME]`

          [IssueHunt](https://issuehunt.io/) | `issuehunt: USERNAME`

          [Ko-fi](https://ko-fi.com/) | `ko_fi: USERNAME`

          [Liberapay](https://en.liberapay.com/) | `liberapay: USERNAME`

          [Open Collective](https://opencollective.com/) | `open_collective: USERNAME`

          [Patreon](https://www.patreon.com/) | `patreon: USERNAME`

          [Tidelift](https://tidelift.com/) | `tidelift: PLATFORM-NAME/PACKAGE-NAME`

          [ポーラー](https://www.polar.sh/) | `polar: USERNAME`

          [コーヒーを買ってください](https://www.buymeacoffee.com/) | `buy_me_a_coffee: USERNAME`

          [thanks.dev](https://thanks.dev/) | `thanks_dev: u/gh/USERNAME`

カスタム URL | custom: LINK1 または custom: [LINK1, LINK2, LINK3, LINK4]

Tideliftは、次のプラットフォーム名で platform-name/package-name 構文を使用してください。

Language	プラットフォームの名前
JavaScript	`npm`
Python	`pypi`
Ruby	`rubygems`
Java	`maven`
PHP	`packagist`
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 または個人アカウント用にデフォルトのスポンサーボタンを作成できます。詳しくは、「既定のコミュニティ正常性ファイルの作成」をご覧ください。

メモ

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

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

GitHub で、リポジトリのメインページに移動します。1. リポジトリ名の下にある [Settings] をクリックします。 [設定] タブが表示されない場合は、 [] ドロップダウンメニューを選び、 [設定] をクリックします。
[全般] 設定ページの [機能] セクションで、 [スポンサーシップ] を選びます。
[スポンサーシップ] ボックスで、 [スポンサーボタンの設定] または [資金調達リンクを上書きする] をクリックします。
ファイルエディターで、FUNDING.yml ファイルの指示に従って、資金調達の場所へのリンクを追加します。
[変更のコミット...] をクリックします。
[コミットメッセージ] フィールドに、ファイルに対する変更内容を説明する、短くわかりやすいコミットメッセージを入力します。コミットメッセージでは、複数の作者にコミットを関連づけることができます。詳しくは、「複数の作者を持つコミットを作成する」をご覧ください。
コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。詳しくは、「pull request の作成」をご覧ください。
[変更のコミット] または [変更の提案] をクリックします。

参考資料

        [AUTOTITLE](/sponsors/receiving-sponsorships-through-github-sponsors/about-github-sponsors-for-open-source-contributors)

        [GitHub Sponsors チームとの FAQ](https://github.blog/2019-06-12-faq-with-the-github-sponsors-team/)はthe GitHub Blogで

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

この記事で

FUNDING ファイルについて

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

参考資料