如何为自己的Composer包添加贡献者信息_在composer.json中定义authors字段

在composer.json中通过authors字段列出贡献者可提升包的专业度,该数组支持name、email、homepage和role信息,建议仅包含核心成员并随版本更新维护。

如何为自己的composer包添加贡献者信息_在composer.json中定义authors字段

在发布自己的Composer包时,为项目添加贡献者信息能让使用者了解背后的开发团队或个人。最直接的方式是在 composer.json 文件中定义 authors 字段。这个字段不仅有助于建立信任,还能在 Packagist 等平台上正确展示作者信息。

1. 在 composer.json 中设置 authors 字段

authors 字段是一个数组,允许你列出一个或多个贡献者。每个贡献者以对象形式存在,支持以下键:

  • name:贡献者姓名(必填)
  • email:邮箱地址(可选,但推荐)
  • homepage:个人主页或博客链接(可选)
  • role:在项目中的角色,如“开发者”、“维护者”等(可选)

示例:

{
    "name": "your-vendor/your-package",
    "description": "A sample Composer package",
    "authors": [
        {
            "name": "张三",
            "email": "zhangsan@example.com",
            "homepage": "https://example.com",
            "role": "lead developer"
        },
        {
            "name": "李四",
            "email": "lisi@example.com",
            "role": "contributor"
        }
    ],
    "require": {}
}

2. 多人协作项目的处理建议

如果项目有多个活跃贡献者,建议在每次重要提交或版本发布前更新 authors 列表。虽然 Git 记录了所有提交者,但 composer.json 中的 authors 更偏向于核心维护者或主要贡献者。

MagicArena MagicArena

字节跳动推出的视觉大模型对战平台

MagicArena 163 查看详情 MagicArena
  • 不要将所有 Git 提交者都加入 authors,避免列表过长
  • 定期审查 authors 列表,确保信息准确
  • 若项目由组织维护,可只写组织名,或指定代表人

3. 发布后信息展示

当你将包提交到 Packagist 后,authors 字段会自动被解析并在网页上展示。用户通过命令 composer show your-vendor/your-package 也能查看这些信息。

注意:修改 composer.json 中的 authors 不会自动同步到已发布的版本。如需更新,必须发布新版本(如从 1.0.0 升级到 1.0.1)。

基本上就这些。只要在 composer.json 中正确填写 authors 数组,你的包就能清晰展示贡献者信息,提升专业度和透明度。

以上就是如何为自己的Composer包添加贡献者信息_在composer.json中定义authors字段的详细内容,更多请关注其它相关文章!

本文转自网络,如有侵权请联系客服删除。