This outlines how to propose a change to calcofi4r. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you’ll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.
If you want to make a bigger change, it’s a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).
Fork the package and clone onto your computer. If you haven’t done this before, we recommend using usethis::create_from_github("CalCOFI/calcofi4r", fork = TRUE).
Install all development dependencies 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 usethis::pr_init("brief-description-of-change").
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 Fixes #issue-number.
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.
New code should follow the tidyverse style guide. You can use the styler package to apply these styles, but please don’t restyle code that has nothing to do with your PR.
We use roxygen2, with Markdown syntax, for documentation.
We use testthat for unit tests. Contributions with test cases included are easier to accept.
# convert inline ROxygen2 documentation from R/*.R to man/*.Rd
devtools::document()
# build website Reference and function documentation into docs/
pkgdown::build_reference()
# OR build entire website into docs/
pkgdown::build_site()The versions of pkgdown and Pandoc used to build a website are stored in the public facing [pkgdown.yml file, e.g. https://dplyr.tidyverse.org/pkgdown.yml.
If you encounter unexpected errors after running pkgdown::build_site(), try to build a minimal package that recreates the error. An ideal minimal package has no dependencies, making it easy to install and quickly reproduce the error. An example of a minimal package was this issue, where a minimal package containing a single .R file with two lines could reproduce the error.
The quickest way to set up minimal example package is with usethis::create_package():
usethis::create_package("~/desktop/testpackage")
# ... edit files ...
pkgdown::build_site(tmp, new_process = FALSE, preview = FALSE)Once you have built a minimal package that recreates the error, create a GitHub repository from the package (e.g. with usethis::use_git() + usethis::use_github()), and file an issue with a link to the repository.
If you encounter problems with Rd tags, please use rd2html() to create a reprexes:
Please note that the calcofi4r project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.