在分叉和改进 Github 存储库后,我应该更改 package.json 中的作者吗?
Posted
技术标签:
【中文标题】在分叉和改进 Github 存储库后,我应该更改 package.json 中的作者吗?【英文标题】:Should I change author in package.json after forking and improving a Github repo? 【发布时间】:2019-06-20 19:47:33 【问题描述】:我分叉了某人的回购并添加了功能。我贡献的数量还不到它现在所有功能的一半。
在package.json
的fork中,他的名字还在作者字段中。
我应该将作者字段更改为我自己并将他添加为contributors
字段的贡献者吗?还是应该按原样保留作者字段并将我添加为贡献者?
【问题讨论】:
这是个好问题。当您是 2 个人,一个包的共同作者时,也会发生这种情况。然后呢?我认为author
键不够灵活。它还应该接受一系列作者。在其他情况下,author
仅仅是包的“创建者”,而不是大部分代码的作者。连1%都没有。代码将完全转换,不会在 NPM 中分发。示例:project starters/generators... 用 Gatsby 启动一个站点,它会生成一个带有官方样板的基础项目,但 package.json 中已经有一个 author
。然后呢?
contributors
键(在关于 package.json 的官方 npm 页面中甚至没有提到)就像:“嘿,这个人也在这里做了一些工作”......但我仍然是主要作者。我想这是一件困难的事情。抱歉,这不是答案,而是更多问题,@christiaan-westerbeek。无论如何,在那种情况下,或多或少 50% 的代码,你们俩都应该在 contributors
上(但有一点,contributors
甚至没有被 NPM 解析......例如,eslint
包。列表3 人(不是authors
键,不是contributors
不是github.com/eslint/eslint/graphs/contributors)。
好吧,我错了。 TIL:npm.github.io/using-pkgs-docs/package-json/… 甚至提到了 maintainers
键。也许那个键更适合这个(似乎它应该与contributors
键具有相同的形状)。
【参考方案1】:
所以我也遇到了这个问题。从@juanriqgon 的评论开始,您可以添加贡献者(按照贡献最多的人的顺序 - 可能会为此在包中添加注释)。
"contributors" : [
"name" : "Barney Rubble",
"email" : "b@rubble.com",
"url" : "http://barnyrubble.tumblr.com/"
,
"name" : "Newton Bubble",
"email" : "n@bubble.com",
"url" : "http://newtonbubble.tumblr.com/"
]
来源:https://docs.npmjs.com/cli/v7/configuring-npm/package-json#people-fields-author-contributors
希望这对社区有所帮助!
【讨论】:
以上是关于在分叉和改进 Github 存储库后,我应该更改 package.json 中的作者吗?的主要内容,如果未能解决你的问题,请参考以下文章
将原始 GitHub 存储库中的新更新拉入分叉的 GitHub 存储库