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.

In this article

About FUNDING files

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 GitHub Sponsors, external funding platforms, or a custom funding URL. For more information about GitHub 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 GitHub Sponsors. Add each platform on a new line, using the following syntax:

PlatformSyntax
CommunityBridgecommunity_bridge: PROJECT-NAME
GitHub Sponsorsgithub: USERNAME or github: [USERNAME, USERNAME, USERNAME, USERNAME]
IssueHuntissuehunt: USERNAME
Ko-fiko_fi: USERNAME
Liberapayliberapay: USERNAME
Open Collectiveopen_collective: USERNAME
Otechieotechie: USERNAME
Patreonpatreon: USERNAME
Tidelifttidelift: PLATFORM-NAME/PACKAGE-NAME
Custom URLcustom: LINK1 or custom: [LINK1, LINK2, LINK3, LINK4]

For Tidelift, use the platform-name/package-name syntax with the following platform names:

LanguagePlatform name
JavaScriptnpm
Pythonpypi
Rubyrubygems
Javamaven
PHPpackagist
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: If a custom URL in an array includes :, you must wrap the URL in quotes. For example, "https://www.paypal.me/octocat".

You can create a default sponsor button for your organization or user account. For more information, see "Creating a default community health file."

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 GitHub Support or GitHub Premium Support.

Displaying a sponsor button in your repository

Anyone with admin permissions can enable a sponsor button in a repository.

  1. On GitHub, navigate to the main page of the repository.
  2. Under your repository name, click Settings.
    Repository settings button
  3. Under Features, select Sponsorships.
    Checkbox to enable Sponsorships
  4. Under "Sponsorships", click Set up sponsor button or Override funding links.
    Button to set up sponsor button
  5. In the file editor, follow the instructions in the FUNDING.yml file to add links to your funding locations.
    Edit the FUNDING file to add links to funding locations
  6. At the bottom of the page, type a short, meaningful commit message that describes the change you made to the file. You can attribute the commit to more than one author in the commit message. For more information, see "Creating a commit with multiple co-authors."
    Commit message for your change
  7. Below the commit message fields, decide whether to add your commit to the current branch or to a new branch. If your current branch is master, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a new pull request."
    Commit branch options
  8. Click Propose new file.
    Propose new file button

Further reading

Ask a human

Can't find what you're looking for?

Contact us