ドキュメントには頻繁に更新が加えられ、その都度公開されています。本ページの翻訳はまだ未完成な部分があることをご了承ください。最新の情報については、英語のドキュメンテーションをご参照ください。本ページの翻訳に問題がある場合はこちらまでご連絡ください。

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

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

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

ここには以下の内容があります:

FUNDING ファイルについて

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

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

プラットフォーム 構文
CommunityBridge community_bridge: プロジェクト名
GitHub Sponsors github: ユーザ名 または github: [ユーザ名, ユーザ名, ユーザ名, ユーザ名]
IssueHunt issuehunt: ユーザ名
Ko-fi ko_fi: ユーザ名
Liberapay liberapay: ユーザ名
Open Collective open_collective: ユーザ名
Otechie otechie: ユーザ名
Patreon patreon: ユーザ名
Tidelift tidelift: プラットフォーム名/パッケージ名
カスタム URL custom: リンク 1 または custom: [リンク 1, リンク 2, リンク 3, リンク 4]

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]

Note: If a custom URL in an array includes :, you must wrap the URL in quotes. For example, "https://www.paypal.me/octocat".

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

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

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

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

  2. リポジトリ名の下で [Settings] をクリックします。

    リポジトリの設定ボタン

  3. [Features] で [Sponsorships] を選択します。

    [Sponsorships] を有効化するチェックボックス

  4. [Sponsorships] の下にある [Set up sponsor button] をクリックします。

    スポンサーボタンを設定するボタン

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

    Edit the FUNDING file to add links to funding locations

  6. ページの下部で、ファイルに行った変更について述べた短く意味のあるコミットメッセージを入力してください。コミットメッセージ内でコミットを複数の作者に関連付けることができます。詳細は「複数の共同作者を持つコミットを作成する」を参照してください。

    変更のコミットメッセージ

  7. コミットメッセージフィールドの下で、コミットを現在のブランチに追加するか、新しいブランチを作成するかを判断してください。現在のブランチが master なら、コミットに新しいブランチを作成することにして、プルリクエストを作成してください。

    Commit branch options

  8. [Propose new file(新しいファイルを提案)] をクリックしてください。

    Propose new file ボタン

参考リンク

担当者にお尋ねください

探しているものが見つからなかったでしょうか?

弊社にお問い合わせください