Introduction
This section of the website is dedicated to materials you may need when you want to make a contribution to The Carpentries Workbench. It will detail the minimum developer environment required to contribute to the components of this project.
We are still assembling the documentation for this part of the site. If you would like to contribute, please feel free to open an issue.
The core of The Carpentries Workbench consists of three packages:
These packages are all available and released to the Carpentries R-Universe, which checks for updates to the source packages hourly.
If you are interested, we have documentation for the release process available.
Development
Development of The Workbench is overseen by Zhian N. Kamvar. New features are added incrementally as pull requests. Pushes to the main branch are rare and discouraged. New features must have tests associated (with the exception of {varnish}).
Documentation
Reference documentation for individual functions for each package is written alongside the function using {roxygen2}.
This documentation is generated by devtools::document()
Testing
Tests for each package live in tests/testthat/
and follow a test-[file-name].R
naming convention. These are controlled by the {testthat} package and run by devtools::test()
.
Note that {sandpaper} tests take a long time to run and require internet.
Continous Integration
The continous integration for each package tests on Ubuntu, MacOS, and Windows systems with the last five versions of R (same as the RStudio convention).
Coming up:
- Testing Pull Requests (Locally and on your fork)
- Resources for R package development
- Adding functionality to {sandpaper}
- Adding functionality to {pegboard}
- Adding styling elements to {varnish}
- Adding functionality to carpentries/actions