Skip to content

Commit

Permalink
feat(allcontributors): Adds avatars to README
Browse files Browse the repository at this point in the history
Uses {allcontributors} in a GitHub action to add 3 lists of contributors
to the README. Also, updates the DESCRIPTION file to reflect Kelli
being the project lead, authors have committed code, and contributors
have contributed code at some time but are not active authors. Some of
these decisions were discussed during a seaside chat on August 22, 2024
and some was discussed during an Implementation Team Meeting on
October 23, 2024. We will be using our own GitHub action unless the
action can be moved to GitHub actions for R and created into a reusable
workflow.
  • Loading branch information
kellijohnson-NOAA committed Dec 18, 2024
1 parent 0022b4b commit 668f353
Show file tree
Hide file tree
Showing 3 changed files with 159 additions and 41 deletions.
38 changes: 38 additions & 0 deletions .github/workflows/call-allcontributors.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
name: Collect contributors

on:
workflow_dispatch:
schedule:
- cron: '0 8 * * 1'

jobs:
run-r-script:
runs-on: ubuntu-latest
env:
GITHUB_PAT: ${{ secrets.GITHUB_TOKEN }}
permissions:
contents: write
pull-requests: write
steps:
- name: Checkout repository
uses: actions/checkout@v3
- name: Setup R
uses: r-lib/actions/setup-r@v2

- uses: r-lib/actions/setup-r-dependencies@v2
with:
packages: |
gh
allcontributors
- name: Collect contributor data
run: Rscript -e 'allcontributors::add_contributors(files = c("README.md"), alphabetical = FALSE)'
- name: Create Pull Request
uses: peter-evans/create-pull-request@v5
with:
commit-message: "Update contributors"
branch: update-contributors
title: "Update contributors"
body: "This PR updates the contributors list."
labels: "auto-update"
add-paths: |
README.md
160 changes: 119 additions & 41 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -2,44 +2,122 @@ Package: FIMS
Title: The Fisheries Integrated Modeling System
Version: 0.2.0.0
Authors@R: c(
person("Christine", "Stawitz", , "[email protected]", role = c("aut", "cre"),
comment = c(ORCID = "0000-0003-3122-4501")),
person("Nathan", "Vaughan", role = "aut"),
person("Howard", "Townsend", role = "aut"),
person(c("Ian", "G."), "Taylor", role = "aut",
comment = c(ORCID = "0000-0002-4232-5669")),
person("Matthew", "Supernaw", role = "aut"),
person("Jane", "Sullivan", role = "aut"),
person("Kyle", "Shertzer", role = "aut",
comment = c(ORCID = "0000-0001-7196-5959")),
person("Megumi", "Oshima", role = "aut"),
person(c("Cole", "C."), "Monnahan", role = "aut",
comment = c(ORCID = "0000-0003-0871-6700")),
person(c("Timothy", "J."), "Miller", role = "aut",
comment = c(ORCID = "0000-0003-1411-1206")),
person("Richard", "Methot", role = "aut"),
person("Patrick", "Lynch", role = "aut",
comment = c(ORCID = "0000-0001-7121-6181")),
person("Bai", "Li", role = "aut",
comment = c(ORCID = "0000-0002-8249-1442")),
person("Huihua", "Lee", role = "aut"),
person(c("Christopher", "M."), "Legault", role = "aut",
comment = c(ORCID = "0000-0002-0328-1376")),
person(c("Kelli", "F."), "Johnson", role = "aut",
comment = c(ORCID = "0000-0002-5149-451X")),
person(c("James", "N."), "Ianelli", role = "aut",
comment = c(ORCID = "0000-0002-7170-8677")),
person("Alan", "Haynie", role = "aut"),
person(c("Andrea", "M."), "Havron", role = "aut",
comment = c(ORCID = "0000-0002-4080-448X")),
person(c("Kathryn", "L."), "Doering", role = "aut",
comment = c(ORCID = "0000-0002-0396-7044")),
person(c("Edward", "J."), "Dick", role = "aut",
comment = c(ORCID = "0000-0001-7681-9176")),
person("Jon", "Brodziak", role = "aut"),
person("Kristan", "Blackhart", role = "aut"),
person("Peter", "Kuriyama", role = "aut",
comment = c(ORCID = "0000-0002-6971-4015"))
person(
role = c("aut", "cre"),
family = "Johnson",
given = c("Kelli", "F."),
email = "[email protected]",
comment = c(ORCID = "0000-0002-5149-451X")
),
person(
role = "aut",
family = "Brodziak",
given = c("Jon", "K.", "T."),
comment = c(ORCID = "0000-0001-8690-5588")
),
person(
role = "aut",
family = "Doering",
given = c("Kathryn", "L."),
comment = c(ORCID = "0000-0002-0396-7044")
),
person(
role = "aut",
family = "Havron",
given = c("Andrea", "M."),
comment = c(ORCID = "0000-0002-4080-448X")
),
person(
role = "aut",
family = "Klasky",
given = c("Ronald"),
comment = c(ORCID = "0009-0004-7563-7716")
),
person(
role = "aut",
family = "Kuriyama",
given = c("Peter", "T."),
comment = c(ORCID = "0000-0002-6971-4015")
),
person(
role = "aut",
family = "Legault",
given = c("Christopher", "M."),
comment = c(ORCID = "0000-0002-0328-1376")
),
person(
role = "aut",
family = "Li",
given = "Bai",
comment = c(ORCID = "0000-0002-8249-1442")
),
person(
role = "aut",
family = "Miller",
given = c("Timothy", "J."),
comment = c(ORCID = "0000-0003-1411-1206")
),
person(
role = "aut",
family = "Monnahan",
given = c("Cole", "C."),
comment = c(ORCID = "0000-0003-0871-6700")
),
person(
role = "aut",
family = "Oshima",
given = c("Megumi", "C."),
comment = c(ORCID = "0009-0002-2239-1594")
),
person(
role = "aut",
family = "Shertzer",
given = c("Kyle", "W."),
comment = c(ORCID = "0000-0001-7196-5959")
),
person(
role = "aut",
family = "Stawitz",
given = c("Christine", "C."),
email = "[email protected]",
comment = c(ORCID = "0000-0003-3122-4501")
),
person(
role = "aut",
family = "Sullivan",
given = c("Jane", "Y."),
comment = c(ORCID = "0000-0002-8094-1673")
),
person(
role = "aut",
family = "Supernaw",
given = "Matthew",
comment = c(ORCID = "0009-0007-3681-7433")
),
person(
role = "aut",
family = "Taylor",
given = c("Ian", "G."),
comment = c(ORCID = "0000-0002-4232-5669")
),
person(
role = "aut",
family = "Vaughan",
given = c("Nathan", "R."),
comment = c(ORCID = "0009-0000-3054-6950")
),
person(
role = "ctb",
family = "Blackhart",
given = "Kristan",
comment = c(ORCID = "0000-0003-4232-2510")
),
person(
role = "ctb",
family = "Ianelli",
given = c("James", "N."),
comment = c(ORCID = "0000-0002-7170-8677")
)
)
Description: The Fisheries Integrated Modeling System is a next-generation
framework of stock assessment models, assisting fishery managers with
Expand Down Expand Up @@ -70,7 +148,7 @@ Imports:
tibble,
TMB (>= 1.8.0),
utils
Suggests:
Suggests:
covr,
knitr,
mockery,
Expand All @@ -82,11 +160,11 @@ Suggests:
tidyr,
usethis,
withr
LinkingTo:
LinkingTo:
Rcpp,
RcppEigen,
TMB
VignetteBuilder:
VignetteBuilder:
knitr
Config/testthat/edition: 3
Config/testthat/parallel: true
Expand Down
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,8 @@ All contributors participating and contributing to the FIMS project are expected

****************************

## Contributors

## NOAA Disclaimer

This repository is a scientific product and is not official communication of the National Oceanic and Atmospheric Administration, or the United States Department of Commerce. All NOAA GitHub project code is provided on an 'as is' basis and the user assumes responsibility for its use. Any claims against the Department of Commerce or Department of Commerce bureaus stemming from the use of this GitHub project will be governed by all applicable Federal law. Any reference to specific commercial products, processes, or services by service mark, trademark, manufacturer, or otherwise, does not constitute or imply their endorsement, recommendation or favoring by the Department of Commerce. The Department of Commerce seal and logo, or the seal and logo of a DOC bureau, shall not be used in any manner to imply endorsement of any commercial product or activity by DOC or the United States Government.
Expand Down

0 comments on commit 668f353

Please sign in to comment.