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

FUNDING ファイルについて

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

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

プラットフォーム	構文
LFX Mentorship (旧称 CommunityBridge)	`community_bridge: PROJECT-NAME`
GitHub Sponsors	`github: USERNAME` または `github: [USERNAME, USERNAME, USERNAME, USERNAME]`
IssueHunt	`issuehunt: USERNAME`
Ko-fi	`ko_fi: USERNAME`
Liberapay	`liberapay: USERNAME`
Open Collective	`open_collective: USERNAME`
Otechie	`otechie: USERNAME`
Patreon	`patreon: USERNAME`
Tidelift	`tidelift: PLATFORM-NAME/PACKAGE-NAME`
カスタム URL	`custom: LINK1` または `custom: [LINK1, LINK2, LINK3, LINK4]`

Tidelift の場合は、次のプラットフォーム名で platform-name/package-name 構文を使用します。

言語	プラットフォームの名前
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 または個人アカウント用にデフォルトのスポンサーボタンを作成できます。詳細については、「Creating a default community health file」 (既定のコミュニティ正常性ファイルの作成) を参照してください。

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