Skip to main content

在仓库中显示赞助者按钮

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

关于 FUNDING 文件

可通过编辑默认分支上存储库的 .github 文件夹中的 FUNDING.yml 文件来配置赞助者按钮。 您也可以配置此按钮,以通过 GitHub Sponsors、外部资助平台或自定义资助 URL 来包括被赞助的开发者。 有关 GitHub Sponsors 的详细信息,请参阅“关于 GitHub 赞助者”。

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

平台语法
LFX Mentorship(以前称为 CommunityBridge)community_bridge: PROJECT-NAME
GitHub Sponsorsgithub: USERNAMEgithub: [USERNAME, USERNAME, USERNAME, USERNAME]
IssueHuntissuehunt: USERNAME
Ko-fiko_fi: USERNAME
Liberapayliberapay: USERNAME
Open Collectiveopen_collective: USERNAME
Otechieotechie: USERNAME
Patreonpatreon: USERNAME
Tidelifttidelift: PLATFORM-NAME/PACKAGE-NAME
自定义 URLcustom: LINK1custom: [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 上,导航到存储库的主页。 1. 在存储库名称下,单击 “设置”。 “存储库设置”按钮
  2. 在“功能”下,选择“赞助”。 用于启用“赞助”的复选框
  3. 在“赞助”下,单击“设置赞助者按钮”或“替代资助链接” 。 用于设置“赞助者按钮”的按钮
  4. 在文件编辑器中,按照“FUNDING.yml”文件中的说明将链接添加到你的资助位置。 编辑 FUNDING 文件以将链接添加到资助位置 1. 在页面底部,输入一条简短、有意义的提交消息,描述您对文件所作的更改。 您可以在提交消息中将提交归于多个作者。 有关详细信息,请参阅“创建具有多个共同作者的提交”。 更改的提交消息 1. 在提交消息字段下面,确定是要将提交添加到当前分支还是新分支。 如果当前分支是默认分支,则应选择为提交创建新分支,然后创建拉取请求。 有关详细信息,请参阅“创建新的拉取请求”。 提交分支选项 1. 单击“提供新文件”。 “提供新文件”按钮

延伸阅读