关于 FUNDING 文件
您可以通过编辑仓库`.github`文件夹中默认分支上的`FUNDING.yml`文件来配置您的赞助按钮。您可以配置按钮以包含 GitHub Sponsors 中的赞助开发者、外部资助平台或自定义资助 URL。有关 GitHub Sponsors 的更多信息,请参阅“关于 GitHub Sponsors”。
每个外部资助平台可以添加一个用户名、包名或项目名称,最多可以添加四个自定义 URL。您可以在 GitHub Sponsors 中添加一个组织和最多四个赞助开发者。使用以下语法在新的一行中添加每个平台。
平台 | 语法 |
---|---|
LFX Mentorship(以前称为 CommunityBridge) | community_bridge: PROJECT-NAME |
GitHub Sponsors | github: USERNAME 或 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 |
thanks.dev | thanks_dev: USERNAME |
自定义 URL | custom: LINK1 或 custom: [LINK1, LINK2, LINK3, LINK4] |
对于 Tidelift,请使用以下平台名称使用`platform-name/package-name`语法。
语言 | 平台名称 |
---|---|
JavaScript | npm |
Python | pypi |
Ruby | rubygems |
Java | maven |
PHP | packagist |
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 支持。
在您的仓库中显示赞助按钮
任何拥有管理员权限的用户都可以在仓库中启用赞助按钮。
-
在 GitHub 上,导航到仓库的主页。
-
在您的仓库名称下,点击 **设置**。如果您看不到“设置”选项卡,请选择****下拉菜单,然后点击**设置**。
-
在“常规”设置页面上的“功能”部分中,选择**赞助**。
-
在“赞助”框中,点击**设置赞助按钮**或**覆盖资金链接**。
-
在文件编辑器中,按照`FUNDING.yml`文件中的说明添加指向您的资金位置的链接。
-
点击**提交更改…**
-
在“提交消息”字段中,键入简短且有意义的提交消息,描述您对文件所做的更改。您可以在提交消息中将提交归因于多个作者。有关更多信息,请参阅“创建具有多个作者的提交”。
-
在提交消息字段下方,决定是将您的提交添加到当前分支还是添加到新分支。如果您的当前分支是默认分支,则应选择为您的提交创建一个新分支,然后创建一个拉取请求。有关更多信息,请参阅“创建拉取请求”。
-
点击**提交更改**或**提出更改**。
进一步阅读
- “关于 GitHub Sponsors 的开源贡献者”
- GitHub 博客上的“GitHub Sponsors 团队常见问题解答”