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

FUNDING ファイルについて

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

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

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

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

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

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

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

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

1. GitHubで、リポジトリのメインページにアクセスしてください。
2. リポジトリ名の下で Settings（設定）をクリックしてください。
   
3. [Features] で [Sponsorships] を選択します。
   
4. [Sponsorships] で、[Set up sponsor button] または [Override funding links] をクリックします。
   
5. ファイルエディタで、FUNDING.yml ファイルにある指示に従って、資金獲得の場所へのリンクを追加します。
   
6. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳しい情報については「複数の共作者を持つコミットの作成」を参照してください。
   
7. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチが master であれば、コミット先として新しいブランチを作成することを選択し、続いてプルリクエストを作成しなければなりません。 詳しい情報については「新しいプルリクエストの作成」を参照してください。
   
8. Propose new file（新規ファイルの提案）をクリックしてください。
   

参考リンク

• 「オープンソースコントリビューターに対する GitHub Sponsors について」
• GitHub ブログ の「GitHub Sponsors Team に関するよくある質問」