在composer.json中通过support字段定义文档、问题追踪等支持信息,可提升项目可用性。例如配置docs指向使用文档,issues链接到gitHub Issues,source指向代码仓库,rss提供更新日志订阅,这些信息会显示在Packagist页面侧边栏,方便用户快速获取帮助资源。

在 `composer.json` 中定义支持信息,比如文档地址或问题追踪系统(issue tracker),可以通过 support 字段来实现。这个字段用于告诉用户项目相关的支持资源位置,对开源库尤其有用。
support 字段的作用
support 字段不会影响依赖解析或安装行为,但它会出现在 Packagist 页面上,并可用于工具展示帮助链接。常见用途包括提供:
- 项目文档地址
- 问题反馈(Issue Tracker)链接
- 官方论坛或社区支持链接
- 官方网站
基本写法示例
在 composer.json 中添加 support 对象:
{ "name": "your-vendor/your-package", "description": "A sample package", "version": "1.0.0", "support": { "docs": "https://docs.your-package.com/", "issues": "https://github.com/your-vendor/your-package/issues", "source": "https://github.com/your-vendor/your-package", "rss": "https://your-blog.com/feed.xml" } }
支持的键值说明
Composer 支持以下标准键(非强制,可选填):
- docs:项目文档的 URL
- issues:问题报告页面,如 GitHub Issues 链接
- source:代码仓库主页(不同于 repository.url)
- rss:更新日志或博客 RSS 订阅地址
- chat:即时聊天支持链接(如 Gitter、Discord)
实际应用场景
当你把包发布到 Packagist 后,这些信息会自动显示在页面侧边栏,方便使用者快速找到帮助资源。例如:
- 用户遇到 bug 可直接点击 “Issues” 提交 issue
- 新手可通过 “Docs” 快速查阅使用说明
- 贡献者能通过 “Source” 查看完整代码仓库
基本上就这些。只要在 composer.json 中正确填写 support 字段,就能提升项目的可用性和维护效率。