Thanks for your interest in contributing to workflowr. Here are some guidelines to help make it easier to merge your Pull Request:
devtools::test()
to run the teststests/testthat/
If you’re new to submitting Pull Requests, please read the section Contribute to other projects in the tutorial A quick introduction to version control with Git and GitHub.
For the most part, I try to follow the guidelines from R packages by Hadley Wickham. The unit tests are performed with testthat, the documentation is built with roxygen2, and the online package documentation is created with pkgdown. Continuous integration testing is performed for Linux by CircleCI, for macOS by Travis CI, and for Windows by AppVeyor. Code coverage is calculated with covr and Codecov.
The template files used by wflow_start()
to populate a new project are defined in the list templates
in the file R/infrastructure.R
. The RStudio project template is configured by inst/rstudio/templates/project/wflow_start.dcf
. The repository contains the files LICENSE
and LICENSE.md
to both adhere to R package conventions for defining the license and also to make the license clear in a more conventional manner (suggestions for improvement welcome). The directory scripts/
contains convenience scripts for maintaining the R package. The remaining directories are standard for R packages as described in the manual Writing R Extensions.
Convenience scripts for maintaining the package are located in scripts/
. These are not included in the package tarball for distribution. They are all intended to be executed from the root directory of the package. The convenience scripts include:
build.sh
runs R CMD build
and R CMD check
bump-version.R
bumps the version across all the necessary package filescontribute.R
performs some basic checks that should be run before contributing a Pull Requestdocument.R
regenerates the documentationgather-dependencies.R
extracts the dependencies from DESCRIPTION
to create the vector dependencies
in R/zzz.R
(which is used to confirm that all the packages that workflowr needs are properly installed)sed.sh
performs search/replace for all R files in the packageBump version with scripts/bump-version.R
Update NEWS.md: Check git log
and make sure to reference GitHub Issues/PRs
Run scripts/document.R to update Rd files, install the package locally, and build the online documentation with pkgdown
Run scripts/build.sh to confirm tests pass locally
Test on rhub:
rhub::validate_email()
. Copy-paste token from email into R consolerhub::check_for_cran(platform = "ubuntu-gcc-devel")
rhub::check_for_cran(platform = "solaris-x86-patched")
Test on winbuilder:
devtools::check_win_devel()
Update cran-comments.md
Commit with git commit -am "Bump version: x.x.x.9xxx -> x.x.x and re-build docs."
Push with git push origin main
and wait for CI builds to pass
Build tarball with R CMD build .
and upload to CRAN submission site. You will receive an email to request confirmation, then an email confirming the package was submitted, and then an email with the test results. Once it is accepted to CRAN, monitor the check results for any surprise errors. Also, these builds are when the binaries are built for Windows and macOS, so they aren’t available until they are finished. You will receive an email once all the Windows binaries are available for download (devel, release, oldrel).
You can monitor the status of the CRAN submission with the foghorn package:
foghorn::cran_incoming("workflowr")
foghorn::cran_details("workflowr")
foghorn::cran_results(pkg = "workflowr")
Tag with git tag -a vx.x.x
. Summarize NEWS.md entry into bullet points. Run git tag -l -n9
for past examples. Push with git push origin --tags
.
Make a release. On GitHub, go to Releases -> Tags -> Edit release notes. Name the release “workflowr x.x.x” and copy-paste the Markdown entry from NEWS.md.