Thanks for your interest in contributing to workflowr. Here are some guidelines to help make it easier to merge your Pull Request:

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.

More about this repository

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.

Scripts for maintaining the package

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 files
  • contribute.R performs some basic checks that should be run before contributing a Pull Request
  • document.R regenerates the documentation
  • sed.sh performs search/replace for all R files in the package

Release checklist (for maintainers)