Composer如何配置项目的作者信息_符合开源社区的标准规范【规范手册】

在开源世界里,一个项目的作者信息如果没写在 composer.json 里,那基本就等于没写——社区和工具链只认这个文件里的 authors 字段。至于 README、LICENSE 甚至 Git 提交记录里的署名,抱歉,那都不算数。
作者字段必须用 authors 数组,不能用 author
这里有个常见的误区:很多人觉得单个作者用 "author": { "name": "xxx" } 就行了。其实不然,Composer 官方只识别复数形式的 authors,而且它必须是一个数组。格式一旦写错,后果可能包括 Packagist 解析失败、贡献者信息无法显示,甚至影响像 GitHub Dependabot 这类自动化工具的贡献归属判断。
- 记住,
authors是强制要求的数组格式,哪怕项目只有你一个人,也得用数组包起来。 - 数组里的每个作者对象,至少得包含
name字段。当然,为了完整和专业,强烈建议补上email和homepage。 role字段是可选的,常用的值有"lead"(主导者)、"maintainer"(维护者)、"contributor"(贡献者)等,这个字段会影响 Packagist 页面上作者信息的展示权重。
{
"authors": [
{
"name": "Zhang San",
"email": "zhang@example.com",
"homepage": "https://zhang.dev",
"role": "lead"
},
{
"name": "Li Si",
"email": "li@example.org",
"role": "maintainer"
}
]
}
邮箱地址要真实可用,且与 Packagist/GitHub 账户绑定
邮箱可不是随便填填就完事的。Packagist 在同步你的包时,会校验 email 是否与其平台账户的注册邮箱匹配;GitHub 的“Used by”统计和贡献图也依赖这个字段来关联身份。如果用了占位邮箱(比如 hello@localhost)或者干脆拼错了,可能导致作者页面空白、收不到重要的安全通告,甚至丧失项目的维护者权限。
- 避免使用像
noreply@github.com这类没有实际收信能力的地址。 - 如果出于隐私考虑不想公开私人邮箱,可以采用一个折中方案:确保 Git 提交时使用的邮箱与 Packagist 绑定的邮箱一致。但无论如何,这个邮箱必须是真实存在且能通过验证的。
- 还有一点需要注意:多个作者共用一个邮箱是行不通的。Packagist 会按邮箱去重,后写入的作者信息会被忽略。
别把公司名、组织名塞进 name 字段
name 字段的初衷是填写自然人姓名,而不是品牌或组织名称。如果你写成 "name": "ACME Corp",Packagist 页面上可能会显示为“ACME Corp (ACME Corp)”,这既不符合 PSR-5(PHPDoc 作者规范)的精神,也容易让社区觉得项目缺乏明确的个人责任人。
- 如果项目是由某个组织主导的,组织信息应该放在
support或homepage字段里来体现。 - 对于个人开发者,直接使用真实姓名或者你长期使用的、公认的 ID 即可(例如
"name": "Jane Doe"或"name": "jane-doe")。 - 顺便提一句,中文姓名完全可以直接使用,无需转成拼音。Packagist 和 GitHub 都支持 UTF-8 编码,显示中文毫无压力。
更新作者信息后,必须重新发布新版本才能生效
这一点至关重要,却常常被忽略:仅仅修改本地的 composer.json 文件中的 authors 字段,并不会自动更新 Packagist 上的页面。你必须通过打一个新标签(例如 v1.2.3)并触发 packagist.org 的 webhook 同步,或者手动去后台点击 “Update” 按钮。在此之前,旧版本的包页面仍然会显示旧的作者信息。
- Git 标签名必须符合语义化版本格式(
vX.Y.Z),否则 Packagist 可能会跳过同步。 - 如果你的项目使用了私有的 Packagist 镜像,需要确认该镜像服务是否支持完整透传
authors字段。 - 在配置 CI/CD 进行自动发布时,要确保对
composer.json的修改和创建新版本标签发生在同一次提交中,以避免因时间差导致的信息错位。
话说回来,最常被跳过的环节就是:开发者兴冲冲地改完了 authors 配置,以为大功告成,却忘了执行发布新版本这一步。请务必记住,Packagist 页面上展示的,永远是你最新已发布版本的元数据,而不是 Git 主干(比如 main 或 master 分支)上的内容。
