Many hands make light work! Here are some ways you can contribute to this project:
.R, not a
.Rdfile. You can find the
.Rfile that generates the
.Rdby reading the comment in the first line.
Fork the package and clone onto your computer. If you haven’t done this before, we recommend using
usethis::create_from_github("dynastyprocess/ffscrapr", fork = TRUE).
Install all development dependences with
devtools::install_dev_deps(), and then make sure the package passes R CMD check by running
devtools::check(). If R CMD check doesn’t pass cleanly, it’s a good idea to ask for help before continuing.
Create a Git branch for your pull request (PR). We recommend using
Make your changes, commit to git, and then create a PR by running
usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain
For user-facing changes, add a bullet to the top of
NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.
We use testthat for unit tests. Contributions with test cases included are easier to accept.