Are you sure you want to delete this access key?
title | intro | redirect_from | versions |
---|---|---|---|
Displaying a sponsor button in your repository | You can add a sponsor button in your repository to increase the visibility of funding options for your open source project. | [/github/building-a-strong-community/displaying-a-sponsor-button-in-your-repository /articles/displaying-a-sponsor-button-in-your-repository] | [{free-pro-team *}] |
You can configure your sponsor button by editing a FUNDING.yml file in your repository's .github
folder, on the default branch. You can configure the button to include sponsored developers in {% data variables.product.prodname_sponsors %}, external funding platforms, or a custom funding URL. For more information about {% data variables.product.prodname_sponsors %}, see "About GitHub Sponsors."
You can add one username, package name, or project name per external funding platform and up to four custom URLs. You can add up to four sponsored developers or organizations in {% data variables.product.prodname_sponsors %}. Add each platform on a new line, using the following syntax:
Platform | Syntax |
---|---|
CommunityBridge | community_bridge: PROJECT-NAME |
{% data variables.product.prodname_sponsors %} | github: USERNAME or 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 |
Custom URL | custom: LINK1 or custom: [LINK1, LINK2, LINK3, LINK4] |
For Tidelift, use the platform-name/package-name
syntax with the following platform names:
Language | Platform name |
---|---|
JavaScript | npm |
Python | pypi |
Ruby | rubygems |
Java | maven |
PHP | packagist |
C# | nuget |
Here's an example FUNDING.yml file:
github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]
{% note %}
Note: If a custom URL in an array includes :
, you must wrap the URL in quotes. For example, "https://www.paypal.me/octocat"
.
{% endnote %}
You can create a default sponsor button for your organization or user account. For more information, see "Creating a default community health file."
{% note %}
Funding links provide a way for open source projects to receive direct financial support from their community. We don’t support the use of funding links for other purposes, such as for advertising, or supporting political, community, or charity groups. If you have questions about whether your intended use is supported, please contact {% data variables.contact.contact_support %}.
{% endnote %}
Anyone with admin permissions can enable a sponsor button in a repository.
{% data reusables.repositories.navigate-to-repo %}
{% data reusables.repositories.sidebar-settings %}
3. Under Features, select Sponsorships.
4. Under "Sponsorships", click Set up sponsor button or Override funding links.
5. In the file editor, follow the instructions in the FUNDING.yml file to add links to your funding locations.
{% data reusables.files.write_commit_message %}
{% data reusables.files.choose_commit_branch %}
{% data reusables.files.propose_new_file %}
Press p or to see the previous file or, n or to see the next file
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?
Are you sure you want to delete this access key?