From bab879c87b67744313d222d0e7e0353a383c36fa Mon Sep 17 00:00:00 2001 From: "Katie Gostic (she/her)" Date: Mon, 26 Aug 2024 11:12:40 -0700 Subject: [PATCH] Updated authorship and added package authorship guidelines (#13) * Updated authorship and added package authorship guidelines to docs/project-standards.md * Merge authorship standard with `CONTRIBUTING.md` --------- Co-authored-by: Zachary Susswein --- CONTRIBUTING.md | 15 +++++++++++++++ DESCRIPTION | 7 +++++-- NEWS.md | 1 + 3 files changed, 21 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5638186f..b9e21a72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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) diff --git a/DESCRIPTION b/DESCRIPTION index d0f66746..f3680839 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -4,8 +4,11 @@ Version: 0.0.0.9000 Authors@R: c( person("Zachary", "Susswein", , "utb2@cdc.gov", role = c("aut", "cre"), comment = c(ORCID = "0000-0002-4329-4833")), - person("Katelyn", "Gostic", , "uep6@cdc.gov", role = "aut", - comment = c(ORCID = "0000-0002-9369-6371")) + person("Katelyn", "Gostic", , "uep6@cdc.gov", role = "ctb", + comment = c(ORCID = "0000-0002-9369-6371")), + person("Nathan", "McIntosh", , "ute2@cdc.gov", role = "ctb"), + person("Patrick", "Corbett", , "pyv3@cdc.gov", role = "ctb"), + person("Adam", "Howes", , "xwg3@cdc.gov", role = "ctb") ) Description: Add logging, metadata handling, and data handling functions to use EpiNow2 in a pipeline. This pipeline is optimized diff --git a/NEWS.md b/NEWS.md index 0f525c50..9b1bcbed 100644 --- a/NEWS.md +++ b/NEWS.md @@ -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