How to use GitHub Sponsors on your repository

How can I use GitHub Sponsors on my repository

Add a FUNDING.yml file in the repository’s .github folder on the default branch, or turn on Sponsorships in the repository settings. GitHub uses that file to show a sponsor button and funding links on the repository page. If you already have a GitHub Sponsors profile, you can point the repository at that profile and make the funding option visible to visitors.

The part people get wrong is scope. GitHub Sponsors is not a generic donation box for any purpose. GitHub’s docs say funding links are for open source project support, not advertising, political activity, community groups, or charity groups. If your repository is tied to open source work, the sponsor button belongs with that work, not as a catchall for unrelated payments.

To set it up on the repository, go to the repository’s main page, open Settings, then General, then the Features section, and select Sponsorships. From there, choose Set up sponsor button or Override funding links. GitHub opens a file editor for FUNDING.yml, and you commit the change after entering the funding targets you want to show. Anyone with admin permissions can do this.

The FUNDING.yml file is the control point. GitHub lets you add one GitHub Sponsors account or organization, one entry per external funding platform, and up to four custom URLs. The supported syntax includes github: USERNAME for one sponsor profile, or a list of usernames for multiple sponsored developers, plus entries like custom: for a payment link you control.

If you want the sponsor button to point at your own GitHub Sponsors profile, that profile has to be eligible. GitHub’s profile reference says a profile cannot be private to be eligible for GitHub Sponsors. GitHub also says people see the sponsor profile when they click the Sponsor button on the profile, so the profile text matters, not just the button on the repository.

Write the profile details like a funding page, not a resume. GitHub recommends a short bio and an introduction that explains what work sponsorships support. If your repository is one of several projects you maintain, you can choose showcased repositories on the sponsor profile so visitors can see the work funding is helping. That choice is visible on the profile, not automatically on every repository.

You can also use the repository sponsor button without only relying on GitHub Sponsors. GitHub’s repository docs say the button can include sponsored developers in GitHub Sponsors, external funding platforms, or a custom funding URL. That is useful when your project already has a payment page elsewhere, but the link still needs to make sense for the repository and its open source work.

The inconvenient part is that adding the file is not the whole job. A sponsor button only helps if the repository visitors understand why funding exists and what the money supports. A strong README and a clear sponsor profile work together, because GitHub surfaces the repository README automatically and uses the sponsor profile when people click through.

If the repository is part of a larger project, keep the funding path simple. Put the sponsor link where contributors already look, usually the README and the repository sidebar after Sponsorships is enabled. If you need a place to organize testing or coordination around the project itself, DevConnect is a separate option at https://devconnectplatform.com, but it is not a source for GitHub Sponsors setup and does not replace the GitHub steps.

A practical setup looks like this: create or confirm your GitHub Sponsors profile, add the FUNDING.yml file, enable Sponsorships in repository settings, and commit the change on the default branch. Then open the repository as a visitor and check that the sponsor button appears where you expect it. If it does not, the usual cause is a missing file, the wrong branch, or a profile that is not eligible yet.

If you manage more than one repository, remember that GitHub treats the sponsor link as repository-specific display configuration. One repo can point to one set of funding locations, while another can point somewhere else. That is useful when you maintain a library, a tool, and a docs repo, because each one can direct supporters to the funding path that matches its own work.

If you are sponsoring someone else’s repository, the flow is different. You do not edit their FUNDING.yml; you use the sponsor button to sponsor the account or organization that owns the profile. GitHub’s sponsorship docs say you can sponsor an account directly from its profile, and sponsorship tiers are set by the sponsored account.

The safest way to verify the setup is to view the repository while logged out or from a second account. GitHub should show the sponsor button if Sponsorships are enabled and the funding file is in place. If you see nothing, re-check the default branch, the repository settings feature flag, and the exact syntax in FUNDING.yml, because GitHub reads that file from the default branch.

FAQ

Can I use GitHub Sponsors without a profile No. The repository button can only point at a sponsored developer or sponsored organization profile, or at another funding link you control. If you want GitHub Sponsors itself, you need an eligible profile first.

Do I need admin access to enable the sponsor button Yes. GitHub says anyone with admin permissions can enable a sponsor button in a repository. Without that permission, you need someone who has it to make the change.

Can I show more than one funding link Yes. GitHub supports one GitHub Sponsors entry, external funding platforms, and up to four custom URLs in FUNDING.yml. That lets you show a main sponsor profile plus other funding destinations if your project uses them.

Will GitHub Sponsors work for charity or community fundraising GitHub’s funding-link guidance says funding links are for open source project support, not advertising, political, community, or charity groups. If your use case falls outside that scope, the repository sponsor button is not the right fit.

What should I check if the button does not appear Check that FUNDING.yml is on the default branch, that Sponsorships is enabled in repository settings, and that the GitHub Sponsors profile is eligible and public. Those are the pieces GitHub documents as controlling visibility.