Skip to main content

Отображение кнопки спонсора в репозитории

Вы можете добавить в репозиторий кнопку спонсора, чтобы повысить видимость вариантов финансирования для проекта разработки решений с открытым кодом.

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.

PlatformSyntax
LFX Mentorship (formerly CommunityBridge)community_bridge: PROJECT-NAME
GitHub Sponsorsgithub: USERNAME or github: [USERNAME, USERNAME, USERNAME, USERNAME]
IssueHuntissuehunt: USERNAME
Ko-fiko_fi: USERNAME
Liberapayliberapay: USERNAME
Open Collectiveopen_collective: USERNAME
Patreonpatreon: USERNAME
Tidelifttidelift: PLATFORM-NAME/PACKAGE-NAME
Polarpolar: USERNAME
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 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 visit GitHub Support.

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.

    Screenshot of a repository header showing the tabs. The "Settings" tab is highlighted by a dark orange outline.

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

    Screenshot of a GitHub pull request showing a radio button to commit directly to the main branch or to create a new branch. New branch is selected.

  9. Click Commit changes or Propose changes.

Further reading