Composer中的funding字段通过在composer.json中添加标准化的捐赠渠道,如GitHub、Patreon等,帮助开源项目更易获得资金支持,提升可见度并促进健康生态。
它解决了开源项目长期存在的一个问题:如何让用户更容易地找到并支持他们依赖的项目。
解决方案:
在你的
composer.json
文件中,你可以添加一个 “funding” 字段,它是一个数组,每个元素代表一个支持渠道。每个渠道都需要包含
type
和
url
两个键。
{ "name": "your-vendor/your-package", "description": "Your awesome package", "funding": [ { "type": "github", "url": "https://github.com/your-username/your-repo" }, { "type": "patreon", "url": "https://www.patreon.com/your-patreon-username" }, { "type": "opencollective", "url": "https://opencollective.com/your-opencollective-slug" }, { "type": "custom", "url": "https://your-website.com/donate" } ] }
常见的
type
包括:”github”、”patreon”、”opencollective”、”tidelift” 和 “custom”。
url
则是对应的链接地址。 “custom” 类型允许你添加任何其他的捐赠链接。
Composer 会读取这个字段,并在适当的地方展示这些链接,例如在
composer show
命令的输出中。 一些 IDE 和包管理工具也会利用这个信息,方便用户直接支持项目。
为什么要在 composer.json 中加入 funding 信息?
除了方便用户支持项目外,将 funding 信息加入
composer.json
还能带来一些意想不到的好处。 比如,它可以提高项目的可见度,让更多人知道你可以接受捐赠。 此外,一些平台可能会根据这个信息自动将你的项目纳入其捐赠计划中。 另一方面,对于使用者来说,也能更方便地了解项目是否需要或者接受捐赠,形成一个更健康的开源生态。
Funding 信息会显示在哪里?
Composer 本身会在
composer show
命令中显示 funding 信息。 但更重要的是,一些依赖分析工具和 IDE 也会利用这些信息。 例如,GitHub 可能会在项目页面上显示一个赞助按钮,直接链接到你在
composer.json
中声明的捐赠渠道。 一些商业公司或组织,他们内部使用的依赖分析工具,也会通过这个字段来评估他们所依赖的开源项目,并决定是否进行赞助。
如何选择合适的 funding 类型?
选择哪种 funding 类型,很大程度上取决于你的个人偏好和项目特点。 GitHub Sponsors 适合那些主要在 GitHub 上活跃的项目。 Patreon 适合那些需要长期支持的项目。 Open Collective 适合那些需要管理多个贡献者和费用的项目。 如果你有自己的捐赠渠道,或者希望使用其他的平台,那么 “custom” 类型会是一个不错的选择。 关键在于选择最适合你的项目,并且方便用户支持你的方式。 别忘了,提供多种选择,让用户可以选择他们最喜欢的方式来支持你。