Composer的funding字段可在composer.json中添加赞助渠道,开发者通过composer show查看包信息时会看到资助方式,支持GitHub、Open Collective等平台,提升开源项目透明度并鼓励用户支持。
Composer 是 PHP 的依赖管理工具,它不仅能帮你安装和更新项目所需的库,还提供了一个鲜为人知但非常实用的功能:通过 funding 字段为开源项目寻求经济支持。这个字段不会影响代码运行,但它能让使用你项目的开发者一眼看到支持你的方式。
什么是 funding 字段?
在 composer.json 文件中,funding 字段用于声明项目维护者接受赞助的渠道。当其他开发者使用 composer show
查看你的包信息时,如果设置了 funding 字段,Composer 会提示他们可以通过哪些方式资助该项目。
这不仅提升了项目透明度,也让更多人意识到开源维护需要持续投入,鼓励用户以实际行动支持。
如何添加 funding 字段
只需在项目的 composer.json 文件中加入 funding 键,其值是一个包含赞助平台和链接的数组。每个条目包括类型(type)和 URL(url)。
- type:赞助平台名称,如 github, opencollective, patreon, liberapay, custom 等
- url:指向你个人或项目赞助页面的具体链接
示例:
{ "name": "your-vendor/your-package", "description": "A useful PHP library", "type": "library", "require": { "php": "^8.0" }, "funding": [ { "type": "github", "url": "https://github.com/sponsors/your-username" }, { "type": "opencollective", "url": "https://opencollective.com/your-project" }, { "type": "custom", "url": "https://your-personal-site.com/donate" } ] }
提交后,任何人通过 Composer 安装或查看你的包时,都能看到这些支持选项。
谁会看到这些信息?
当你发布一个包含 funding 字段的包,以下几种情况会触发提示:
- 运行
composer show vendor/package-name
时,终端会显示 funding 链接 - 某些 IDE 或工具在分析依赖时也可能展示这些信息
- 社区成员在评估是否采用某个包时,可能更倾向支持有明确维护支持渠道的项目
虽然不是强制行为,但这种“轻量级提醒”能有效提升赞助转化率。
对开源维护者的建议
设置 funding 字段是零成本、高回报的行为。你可以:
- 使用 GitHub Sponsors、Open Collective 等主流平台降低用户捐赠门槛
- 在 README 中说明资金用途(如服务器费用、开发时间补偿),增强信任感
- 定期更新赞助进展,让支持者感受到反馈
别小看这个字段——很多开发者愿意支持项目,只是不知道从哪里开始。funding 字段正是那扇打开的小门。
基本上就这些。加一行配置,多一种可能。
以上就是Composer如何利用funding字段为你的开源项目寻求支持的详细内容,更多请关注php js git json composer github 工具 php composer json github ide