Displaying a sponsor button in your repository

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.

Platform	Syntax
LFX Mentorship (formerly CommunityBridge)	community_bridge: PROJECT-NAME
GitHub 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
Patreon	patreon: USERNAME
Tidelift	tidelift: PLATFORM-NAME/PACKAGE-NAME
Polar	polar: USERNAME
Buy Me a Coffee	buy_me_a_coffee: USERNAME
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
]

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

Displaying a sponsor button in your repository

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

1. On GitHub.com, navigate to the main page of the repository.

2. Under your repository name, click Settings . If you cannot see the "Settings" tab, select the dropdown menu, then click Settings .

   

3. On the "General" settings page, in the "Features" section, select Sponsorships .

4. In the "Sponsorships" box, 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.

6. Click Commit changes...

7. 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 ."

8. 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 ."

   

9. Click Commit changes or Propose changes .

Further reading

• " About GitHub Sponsors for open source contributors "
• " FAQ with the GitHub Sponsors team " on the GitHub Blog