R包的作者与贡献者——小代码贡献的角色



如果有人向R库提供了有用的代码块,那么他们在包文档中的合适角色是什么?

为什么重要

我看到过这种情况下的贡献者角色,但在回顾了作者和贡献者的定义后,我认为作者是合适的角色。但可能还有其他更合适的东西(或者作者/贡献者都)

国会图书馆怎么说

作者:

负责创作内容主要为文本的作品的个人、家庭或组织,无论媒体类型(如印刷文本、口语、电子文本、触觉文本)或流派(如诗歌、小说、电影剧本、博客)如何。也用于个人等,通过转述、改写或改编另一创作者的作品来创作新作品,从而使修改实质上改变了原作的性质和内容,或改变了表达媒介

贡献者:

负责为资源做出贡献的个人、家庭或组织。这包括那些作品被贡献到更大作品中的人,如选集、连载出版物或其他个人作品的汇编。如果有更具体的角色可用,请选择,例如编辑器、编译器、插图画家

可能的混淆点

  • 当拉取请求被接受时,github会将PR的创建者称为"贡献者">
  • 在日常谈话中,为项目提供有用意见的人可以被合理地称为"贡献者">

正如前面的回答所指出的,我们的想法是区分不同的代码贡献有多大。手册?person页说明:

新方案还增加了根据关系符MARC代码列表的子集指定角色的可能性(URL:https://www.loc.gov/marc/relators/relaterm.html)。给予时人员在创作R包的上下文中的角色建议使用以下用法。

  • "aut"(作者)用于做出实质性贡献的正式作者对该包的贡献,应显示在包引文中
  • "cre"(创建者)用于软件包维护者
  • "ctb"(贡献者)用于制作贡献(如代码补丁等),但不应显示在包裹引文中

还提供了在R包的上下文中使用其他角色的建议("com""cph""ctr""dtc""fnd""rev""ths""trl")。如果包"foo"没有专用的citation文件,则上面提到的引文是从citation("foo")获得的"默认"或"自动"引文。如果有,您仍然可以通过citation("foo", auto = TRUE)获得默认值。详见?citation

回到"作者"与"贡献者"的问题:当我们撰写上述文件(以及Hornik等人在《R期刊》上发表的随附论文)时,我们故意给出了粗略的指导方针,因为"足够实质"的最终决定需要包作者自己做出。这与决定将谁列入科学论文的作者名单与在致谢中提及并不相似,因为不同学科/社区的做法也有很大差异。

一种常见的策略是区分三个贡献级别:

  • 那些做出了很小贡献(如小的修复或改进)的人没有在描述中列出,但在NEWS或Changelog中得到了认可。这适用于通过GitHub或类似平台上的bug/问题跟踪器或小拉请求做出的许多小贡献
  • 那些提供较大补丁程序、小型帮助程序功能、针对特定情况添加内容等的人,应在说明中列为"骗子"(ctb)。这也适用于从其他包或其他源复制代码部分的情况
  • 那些做出了更大和/或持续的贡献,这些贡献足够大,可以在描述和包的默认/自动引用中列为"作者"(aut)

参考:Hornik K,Murdoch D,Zeileis A(2012)。"谁做了什么?R包作者的角色以及如何引用他们。">《R期刊》4(1),64-69。doi:10.32614/RJ-2012-009

我认为这是一个非常有趣的问题,我以前对此感到好奇。

不幸的是,我认为你提供的两个定义并不像你想象的那么清晰。一个问题是,根据你对它们的阅读方式,你可能会认为作者和贡献者都是在包中编写代码的人的正确标签。看看定义中使用的类别中的R包是什么:

你可以将一个包视为"无论媒体类型如何,内容主要是文本的作品"——在这种情况下,在上面写作的人将是作者——或者"个人作品的汇编"——在那种情况下,添加个人作品(如函数)的人将成为贡献者。

在哈德利·威克姆的《R包》一书中,关于作者的部分不得不说:

  • cre:创建者或维护者,如果你有问题。

  • aut:作者,那些对包裹

  • ctb:贡献者,那些贡献较小的人,比如补丁。

(这篇文章的原始来源似乎是这篇文章:Hornik,Murdoch和Zeileis(2012))

使用贡献的大小来确定某人是作者还是贡献者似乎是处理这种区别的好方法

留下了实质性贡献是什么的问题。最终,我认为这必须在作者和贡献者之间进行协商。理想情况下,有一个由创建者/维护者制定的指导方针,或者在可能的PR之前讨论问题。

我在此建议的一条经验法则是询问如果没有一个人的贡献,包的核心功能是否会存在。如果答案是"否",那么此人就是一名作家。如果答案是"是的,但效果不太好",我认为这个人应该是一个贡献者。

相关内容

  • 没有找到相关文章

最新更新