跳至主要内容

在仓库中显示赞助按钮

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

关于 FUNDING 文件

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

每个外部资助平台您可以添加一个用户名、包名或项目名,最多可添加四个自定义 URL。您可以在 GitHub Sponsors 中添加一个组织和最多四位受赞助的开发者。请在新行中添加每个平台,使用以下语法。

平台语法
LFX 导师计划(原 CommunityBridge)community_bridge: PROJECT-NAME
GitHub 赞助者github: 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
Buy Me a Coffeebuy_me_a_coffee: USERNAME
thanks.devthanks_dev: u/gh/USERNAME
自定义链接custom: LINK1 or 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]

注意

如果数组中的自定义链接包含 :,则必须将该链接用引号括起。例如,"https://www.paypal.me/octocat"

您可以为组织或个人账户创建默认的赞助按钮。有关详细信息,请参阅 创建默认社区健康文件

注意

资金链接为开源项目提供了一种直接从社区获取财政支持的方式。我们不支持将资金链接用于其他用途,例如广告、或支持政治、社区或慈善组织。如果您对自己的使用场景是否受支持有疑问,请访问 GitHub 支持

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

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

  1. 在 GitHub 上,导航至仓库的主页面。

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

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

  3. 在 “General” 设置页面的 “Features” 部分,选择 Sponsorships

  4. 在 “Sponsorships” 区域,点击 Set up sponsor buttonOverride funding links

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

  6. 点击 提交更改...

  7. 在“Commit message”字段中,键入简短且有意义的提交信息,描述您对文件所做的更改。您可以在提交信息中将该提交归因于多个作者。欲了解更多信息,请参阅 创建拥有多位作者的提交

  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. 点击 提交更改提议更改

延伸阅读

© . This site is unofficial and not affiliated with GitHub, Inc.