Add essential GitHub Actions for ensuring package health
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Newbie friendliness
- 72/100
Research direction
Start with the existing test suite and the GitHub Actions guidance linked in the issue, including the R packages book and r-lib/actions templates. Add workflows for test coverage, R CMD check, and linting, using usethis templates where helpful. Done means these checks run through GitHub Actions when code changes and complete successfully.
Written by the indexing model from the issue text.
Description
Wrt to the JOSS review at https://github.com/openjournals/joss-reviews/issues/11373, your package is currently missing essential GitHub Actions for continuous integration and package health, including:
test-coverage: You have a test suite but no GitHub Actions workflow to re-run them when the code changes. This could lead to a lot of bugs, being introduced into the code. See the R packages book for guidance.R cmd check: to ensure the package is being built continuously without errorsLinting: These ensure the codeabase is using high standards of R software engineering
For motivation for doing this, see the continuous integration section of the R packages v2 book.
A lot of these can be quickly added using the usethis R package with a lot of templates from R lib.
Please let me know if you need help proceeding with this as I feel strongly about it.
- Dominant language
- R
- Stars
- 2
- Forks
- 3
- PR merge metrics
- No merged PRs in 30d
Getting set up
This project ships no dev container, Dockerfile or contributing guide, so setting up is up to you: start from its README, and see our first-contribution guide for the general steps.
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from CDCgov/nbbp
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 63/100
-
Difficulty 1/5 Under an hour Newbie friendliness 72/100
-
Difficulty 1/5 1-3 hours Newbie friendliness 78/100
-
Unable to install the package on MacOSPossibly taken @jamesmbaazam claimed this 1 day ago. Open
Difficulty 3/5 1-2 days Newbie friendliness 56/100
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 71/100
-
Difficulty 2/5 1-3 hours Newbie friendliness 76/100
OHDSI/PatientLevelPrediction#688 ·
-
Difficulty 2/5 1-3 hours Newbie friendliness 78/100
rfordatascience/tidytuesday#1098 ·
-
Difficulty 1/5 Under an hour Newbie friendliness 84/100
Maintainers usually reply within 1 day
-
Difficulty 1/5 1-3 hours Newbie friendliness 84/100