From 2ad527ce71c458cbc38440bb78ea9535c8730857 Mon Sep 17 00:00:00 2001 From: "Jaime A. Pavlich-Mariscal" Date: Tue, 29 Oct 2024 08:49:31 -0500 Subject: [PATCH 1/2] Added explanation on how to acknowledge a person on the package `DESCRIPTION` and the use of ORCID. Fixes #97 --- contribution-acknowledgements.qmd | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/contribution-acknowledgements.qmd b/contribution-acknowledgements.qmd index 83f9002..30c5878 100644 --- a/contribution-acknowledgements.qmd +++ b/contribution-acknowledgements.qmd @@ -7,6 +7,19 @@ As part of the development process we want to ensure individuals are properly cr Any contributor who matches the criteria described here should feel empowered to add themselves to `DESCRIPTION`. However, ultimately, it is the maintainer's responsibility to ensure that no contribution remains neglected and that everyone is credited as required by our guidelines. +## How to add an individual to package `DESCRIPTION` + +Persons who want to be acknowledged should add themselves into the `Authors@R` section of the `DESCRIPTION` file. + +The basic information they should specify are: first name, last name, and email. In addition, we strongly encourage to add their ORCID in the comment section. For example: + +``` +Authors@R: c( + person("John", "Doe", , "john.doe@organization.org", role = c("aut", "cre"), + comment = c(ORCID = "1234-1234-1234-1234")) + ) +``` + ## Roles in package `DESCRIPTION` Roles in `DESCRIPTION` can be chosen from any of those listed in the [MARC Code List](https://www.loc.gov/marc/relators/relacode.html), but we prioritize the [shorter list of roles defined in the R source code](https://github.com/r-devel/r-svn/blob/dc6a7d6cf9582ca401b1fc386c86046974d34901/src/library/utils/R/sysdata.R#L28-L39) as the primary reference for credit attribution: From ebbd7ebcb0eeb273dd8a8e4f515241a8983b4084 Mon Sep 17 00:00:00 2001 From: Hugo Gruson <10783929+Bisaloo@users.noreply.github.com> Date: Sat, 30 Nov 2024 09:51:24 +0000 Subject: [PATCH 2/2] Fix lints --- contribution-acknowledgements.qmd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/contribution-acknowledgements.qmd b/contribution-acknowledgements.qmd index 30c5878..b6678fc 100644 --- a/contribution-acknowledgements.qmd +++ b/contribution-acknowledgements.qmd @@ -9,11 +9,11 @@ However, ultimately, it is the maintainer's responsibility to ensure that no con ## How to add an individual to package `DESCRIPTION` -Persons who want to be acknowledged should add themselves into the `Authors@R` section of the `DESCRIPTION` file. +Persons who want to be acknowledged should add themselves into the `Authors@R` section of the `DESCRIPTION` file. The basic information they should specify are: first name, last name, and email. In addition, we strongly encourage to add their ORCID in the comment section. For example: -``` +```yaml Authors@R: c( person("John", "Doe", , "john.doe@organization.org", role = c("aut", "cre"), comment = c(ORCID = "1234-1234-1234-1234"))