在您的仓库中显示赞助按钮

您可以在您的仓库中添加赞助按钮，以提高您的开源项目的资金选项的可见度。

在本文中

关于 FUNDING 文件

您可以通过编辑仓库的 .github 文件夹中默认分支上的 FUNDING.yml 文件来配置赞助按钮。您可以配置按钮以包含 GitHub Sponsors 中的赞助开发人员、外部资金平台或自定义资金 URL。有关 GitHub Sponsors 的更多信息，请参阅 "关于 GitHub Sponsors."

每个外部资金平台可以添加一个用户名、包名或项目名称，最多可以添加四个自定义 URL。您可以在 GitHub Sponsors 中添加一个组织和最多四个赞助开发人员。使用以下语法在每行添加一个平台。

平台语法
LFX Mentorship（以前称为 CommunityBridge）community_bridge: PROJECT-NAME
GitHub Sponsorsgithub: USERNAME 或 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
Buy Me a Coffeebuy_me_a_coffee: USERNAME
自定义 URLcustom: LINK1 或 custom: [LINK1, LINK2, LINK3, LINK4]

对于 Tidelift，请使用以下平台名称使用 platform-name/package-name 语法。

语言平台名称
JavaScriptnpm
Pythonpypi
Rubyrubygems
Javamaven
PHPpackagist
C#nuget

以下是一个 FUNDING.yml 文件的示例

github: [octocat, surftocat]
patreon: octocat
tidelift: npm/octo-package
custom: ["https://www.paypal.me/octocat", octocat.com]

注意：如果数组中的自定义 URL 包含 :，则必须将 URL 括在引号中。例如，"https://www.paypal.me/octocat"。

您可以为您的组织或个人帐户创建默认的赞助按钮。有关更多信息，请参阅“创建默认社区健康文件”。

资金链接为开源项目提供了一种从其社区获得直接财务支持的方式。我们不支持将资金链接用于其他目的，例如广告或支持政治、社区或慈善团体。如果您对您的预期用途是否受支持有任何疑问，请访问 GitHub 支持。

在您的仓库中显示赞助按钮

任何具有管理员权限的用户都可以在仓库中启用赞助按钮。

  1. 在 GitHub.com 上，导航到仓库的主页。

  2. 在您的仓库名称下，单击 设置。如果您看不到“设置”选项卡，请选择下拉菜单，然后单击设置。

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

  3. 在“常规”设置页面上的“功能”部分，选择赞助。

  4. 在“赞助”框中，单击设置赞助按钮或覆盖资金链接。

  5. 在文件编辑器中，按照 FUNDING.yml 文件中的说明添加指向您的资金位置的链接。

  6. 单击提交更改...

  7. 在“提交消息”字段中，键入简短、有意义的提交消息，描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。有关更多信息，请参阅“创建具有多个作者的提交”。

  8. 在提交信息字段下方，选择将您的提交添加到当前分支还是新分支。如果您的当前分支是默认分支，您应该选择为您的提交创建一个新分支，然后创建一个拉取请求。有关更多信息，请参阅“创建拉取请求”。

    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. 点击提交更改或提出更改。

进一步阅读