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 one organization and up to four sponsored developers in GitHub Sponsors. Add each platform on a new line, using the following syntax.
|LFX Mentorship (formerly CommunityBridge)|
For Tidelift, use the
platform-name/package-name syntax with the following platform names.
Here's an example
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,
You can create a default sponsor button for your organization or personal 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.
Displaying a sponsor button in your repository
Anyone with admin permissions can enable a sponsor button in a repository.
On GitHub.com, navigate to the main page of the repository.
Under your repository name, click Settings. If you cannot see the "Settings" tab, select the dropdown menu, then click Settings.
On the "General" settings page, in the "Features" section, select Sponsorships.
In the "Sponsorships" box, click Set up sponsor button or Override funding links.
In the file editor, follow the instructions in the
FUNDING.ymlfile to add links to your funding locations.
Click Commit changes...
In the "Commit message" field, 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 authors."
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 the default branch, you should choose to create a new branch for your commit and then create a pull request. For more information, see "Creating a pull request."
Click Commit changes or Propose changes.
- "About GitHub Sponsors for open source contributors"
- "FAQ with the GitHub Sponsors team" on the GitHub Blog