首页
学习
活动
专区
圈层
工具
发布
社区首页 >问答首页 >作者与R包的贡献者-小代码贡献的角色是什么?

作者与R包的贡献者-小代码贡献的角色是什么?
EN

Stack Overflow用户
提问于 2020-02-19 11:30:16
回答 2查看 1.6K关注 0票数 3

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

为什么那么重要

我看到了对这种情况的贡献者角色,但在审查了作者和贡献者的定义之后,我认为作者才是合适的角色。但是也许还有更合适的东西(或者两者都是作者/贡献者)

国会图书馆怎么说的

作者:

一种人、家庭或组织,负责创作主要是文本内容的作品,而不论媒体类型(如印刷文本、口语文字、电子文本、触觉文本)或体裁(如诗歌、小说、剧本、博客)。也可用于人等,通过翻译、重写或改编另一创作者的作品来创作一部新作品,使修改大大改变了原作品的性质和内容,或改变了表达媒介。

撰稿人:

负责对资源作出贡献的人、家庭或组织。这包括那些其工作已经贡献到一个更大的工作,如选集,系列出版物,或其他个别作品的汇编。如果有更具体的角色可用,则更愿意这样做,例如编辑器、编译器、插画家。

可能的混淆点

  • 当接受拉请求时,github将将PR的创建者称为“贡献者”
  • 在日常谈话中,向项目提供有用输入的人可以被合理地称为“贡献者”。
EN

回答 2

Stack Overflow用户

回答已采纳

发布于 2020-02-22 23:27:21

正如以前的答案所指出的,这个想法是为了区分不同的代码贡献有多大。手册页?person解释道:

新方案还增加了基于Relators代码列表(URL:https://www.loc.gov/marc/relators/relaterm.html)的子集指定角色的可能性。在编写R包的上下文中给出人员的角色时,建议使用以下方法。

  • "aut" (作者)用于对软件包做出重大贡献并应在包引用中显示的完整作者。
  • "cre" (Creator)用于包维护人员。
  • "ctb" (贡献者)用于那些贡献较小的作者(如代码补丁等)。但不应该出现在套餐引文中。

还提供了在R包上下文中使用更多角色的建议("com""cph""ctr""dtc""fnd""rev""ths""trl")。上面提到的引文是“默认”或“自动”引用,如果包"foo“没有专用引用文件,则从citation("foo")获得。如果是的话,您仍然可以通过citation("foo", auto = TRUE)获得缺省值。有关更多详细信息,请参阅?citation

回到“作者”和“贡献者”的问题上:当我们写上面的文档时(以及Hornik等人的论文)。我们故意给出了粗略的指导方针,因为最终的决定是“足够大的”需要由包作者自己做出。这与将谁列入科学论文的作者名单而不是在承认中提及的决定并不不一样--对于这一点,不同学科/社区的实践也有很大差异。

一项并不少见的战略是区分三个级别的贡献:

  • 那些贡献很小的人(比如小的修复或改进)没有被列在描述中,而是在新闻或变更中得到承认。这适用于在GitHub或类似平台上通过bug/发布跟踪器或小型拉出请求所做的许多小贡献。
  • 那些提供更大的补丁,小帮助者功能,为特定情况增加的人,等等,他们应该被列在描述中的“分配者”(ctb)。这也适用于从其他包或其他来源复制代码部分的情况。
  • 那些作出了更大的和/或持续的贡献,足以被列为“作者”(aut)的描述和包的默认/自动引用。

参考: Hornik K,默多克D,Zeileis A(2012年)。“谁做了什么?R包作者的角色以及如何称呼他们。”R杂志,4(1),64-69.指定用途:10.32614/RJ-2012-009

票数 8
EN

Stack Overflow用户

发布于 2020-02-21 13:27:44

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

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

你可以把一个包看作“内容上主要是文本的作品,而不管媒体类型如何”--在这种情况下,在它上写作的人将是作者--或者“个人作品的汇编”--在这种情况下,添加个人作品的人,比如函数,将成为贡献者。

在哈德利韦翰( Hadley Wickham )的"R包“一书中,关于提交人的章节必须指出以下几点:

  • cre:创建者或维护者,如果你有问题的话,你应该麻烦的人。
  • 奥特:作者,那些为这个方案做出了重大贡献的人。
  • ctb:贡献者,那些贡献较小的人,比如补丁。

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

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

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

我在此提出的一个经验法则是,询问包的核心功能是否存在,而不需要一个人的贡献。如果答案是“否”,那么这个人就是作者。如果答案是“是的,但它们也不会起作用”,我认为这个人应该是一个贡献者。

票数 2
EN
页面原文内容由Stack Overflow提供。腾讯云小微IT领域专用引擎提供翻译支持
原文链接:

https://stackoverflow.com/questions/60299378

复制
相关文章

相似问题

领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档