Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Detail how to acknowledge a person in DESCRIPTION #129

Merged
merged 2 commits into from
Nov 30, 2024
Merged

Detail how to acknowledge a person in DESCRIPTION #129

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
2ad527c
Added explanation on how to acknowledge a person on the package `DESC…
jpavlich Oct 29, 2024
ebbd7eb
Fix lints
Bisaloo Nov 30, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 13 additions & 0 deletions contribution-acknowledgements.qmd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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", , "[email protected]", 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:
Expand Down
Loading