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 にお問い合わせください。
リポジトリにスポンサーボタンを表示する
管理者権限があるユーザなら誰でも、リポジトリのスポンサーボタンを有効化できます。
- GitHub.com で、リポジトリのメイン ページへ移動します。 1. リポジトリ名の下の [ 設定] をクリックします。
- [機能] で [スポンサーシップ] を選択します。
![[スポンサーシップ] を有効にするチェックボックス](/assets/cb-36772/images/help/sponsors/sponsorships-checkbox.png)
- [スポンサーシップ] で、 [スポンサー ボタンの設定] または [資金調達リンクを上書きする] をクリックします。
- ファイル エディターで、FUNDING.yml ファイルの指示に従って、資金調達の場所へのリンクを追加します。
1. ページの下部で、ファイルに対して行った変更を説明する短く分かりやすいコミットメッセージを入力してください。 コミットメッセージでは、複数の作者にコミットを関連づけることができます。 詳細については、「複数の共同作成者とのコミットの作成」を参照してください。
1. コミットメッセージフィールドの下で、コミットの追加先を現在のブランチか新しいブランチから選択してください。 現在のブランチがデフォルトブランチなら、コミット用に新しいブランチを作成してからPull Requestを作成すべきです。 詳細については、「新しい pull request の作成」を参照してください。
1. [新しいファイルの提案]
![[新しいファイルの提案] ボタン](/assets/cb-54553/images/help/repository/new-file-commit-button.png)
をクリックします へのリンクを追加します
参考資料
- 「オープン ソース共同作成者向けの GitHub Sponsors について」
- the GitHub Blog の「GitHub Sponsors Team に関する FAQ」