📜  Guthub Funding.yml (1)

📅  最后修改于: 2023-12-03 14:41:40.308000             🧑  作者: Mango

GitHub Funding.yml

GitHub Funding.yml 是通过在 GitHub 上创建名为 FUNDING.yml 的文件来启用捐赠选项的方法。该文件列出了您项目的可接受捐赠方式。它可用于证明您对项目的投资价值,并使人们能够以贡献的方式回报您。

特征
  • 支持多种捐赠方式,包括 PayPal、Patreon、Open Collective 和 Ko-Fi 等。
  • 具有明确的格式和语法,易于使用和理解。
  • 可以在组织和个人仓库中使用。
示例

以下是一个示例 FUNDING.yml 文件,演示了如何添加三种不同的捐赠方式:

github: username
patreon: username
paypal: email@example.com
  • github 指定 GitHub 个人或组织帐户,用于在 GitHub Sponsors 中显示捐赠选项。
  • patreon 指定 Patreon 用户名,可在 Patreon 中显示捐赠选项。
  • paypal 指定 PayPal 电子邮件地址,用于接受捐款。

您还可以为每个捐赠方式添加说明、图标和默认金额等属性,以便更好地说明捐赠选项。

github: 
  username: user/repo
  title: 常规捐赠
  description: 如果你觉得这个项目对你有帮助,请考虑进行捐赠,来支持这个项目。
  tiers:
    - 5  # 默认支持 $5 捐款
    - 10
    - 25
patreon:
  username: 123456
  title: Patreon 支持
  description: 通过 Patreon 捐赠来支持我们的项目,以便我们可以继续开发下去。
  tiers:
    - 1  # 最低支持 $1 每月
    - 5
    - 10
paypal:
  email: email@example.com
  title: 通过 PayPal 支持
  description: 如果您喜欢这个项目,请通过 PayPal 进行捐赠来继续帮助我们。谢谢!
使用步骤

要在您的 GitHub 项目中启用捐赠选项,请按照以下步骤操作:

  1. 在项目根目录中创建一个名为 FUNDING.yml 的文件。
  2. 将上述示例文件中的内容添加到 FUNDING.yml 文件中,或根据您的需求修改。
  3. 推送并发布更改。

现在,您的项目页面应该已经更新,显示出来的是您选择的捐赠方式。人们可以通过以下方式贡献:

  • 访问您在 GitHub Sponsors、Patreon 或 Open Collective 上设置的页面。
  • 给您的 PayPal 帐户发送款项。
总结

GitHub Funding.yml 是一种方便的方式,允许您为项目添加捐赠选项,使您能够更好地管理项目,并允许贡献者和用户以贡献的方式回报您。如果您有一个受欢迎的开源项目,那么集资选项可能是一个很棒的方式来尽可能多的支持它。