Skip to content

Commit

Permalink
Updated authorship and added package authorship guidelines (#13)
Browse files Browse the repository at this point in the history
* Updated authorship and added package authorship guidelines to docs/project-standards.md

* Merge authorship standard with `CONTRIBUTING.md`

---------

Co-authored-by: Zachary Susswein <[email protected]>
  • Loading branch information
kgostic and zsusswein authored Aug 26, 2024
1 parent d3b008f commit bab879c
Show file tree
Hide file tree
Showing 3 changed files with 21 additions and 2 deletions.
15 changes: 15 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,21 @@ questions or doubts, don't be afraid to send them our way. We appreciate all
contributions, and we are looking forward to fostering an open, transparent, and
collaborative environment.

## Package authorship
These guidelines build on the recommendations in [R packages](https://r-pkgs.org/).

* Maintainer: The CFA team member who is actively in charge of maintaining the
package.
* Authors: Any CFA team member who has taken a lead role in code development,
review, testing, etc.
* Contributors: Team members who have made smaller but substantial contributions
to the codebase (40+ hours, including coding, code review, testing, etc.)
* Smaller contributions: Smaller contributiosn of code to this repo or
to its predecessor, cdcent/cfa-nnh-pipelines, including small bug fixes,
issuees, or code review will not be granted package authorship in the
description file, but may be acknowledged in NEWS.md or release notes if
appropriate

Before contributing, we encourage you to also read our [LICENSE](LICENSE),
[README](README.md), and
[code-of-conduct](code-of-conduct.md)
Expand Down
7 changes: 5 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,11 @@ Version: 0.0.0.9000
Authors@R: c(
person("Zachary", "Susswein", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-4329-4833")),
person("Katelyn", "Gostic", , "[email protected]", role = "aut",
comment = c(ORCID = "0000-0002-9369-6371"))
person("Katelyn", "Gostic", , "[email protected]", role = "ctb",
comment = c(ORCID = "0000-0002-9369-6371")),
person("Nathan", "McIntosh", , "[email protected]", role = "ctb"),
person("Patrick", "Corbett", , "[email protected]", role = "ctb"),
person("Adam", "Howes", , "[email protected]", role = "ctb")
)
Description: Add logging, metadata handling, and data handling
functions to use EpiNow2 in a pipeline. This pipeline is optimized
Expand Down
1 change: 1 addition & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,3 +2,4 @@

* CI running on Ubuntu only & working pkgdown deploy to Github Pages
* Initial R package with checks running in CI
* Updated DESCRIPTION and added guidelines for package authorship

0 comments on commit bab879c

Please sign in to comment.