This package is in an initially stable state of development, with a great deal of active subsequent development envisioned.
canaper are welcome! Please read this documentation before proceeding.
Small typos or grammatical errors in documentation may be edited directly using the GitHub web interface, so long as the changes are made in the source file.
- YES: you edit a roxygen comment in a
- NO: you edit an
Before you make a substantial pull request, you should always file an issue and make sure someone from the team agrees that it’s a problem. If you’ve found a bug, create an associated issue and illustrate the bug with a minimal reprex.
- We recommend that you create a Git branch for each pull request (PR).
- Look at the build status (
R-CMD-checkbadge) before and after making changes.
- We recommend 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.
- We use testthat. Contributions with test cases included are easier to accept.
- For user-facing changes, add a bullet to the top of
NEWS.mdbelow the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).
Email the person listed as maintainer in the
DESCRIPTION file of this repo.
Though note that private discussions over email don’t help others - of course email is totally warranted if it’s a sensitive problem of any kind.
Please note that this package is released with a Contributor Code of Conduct. By contributing to this project, you agree to abide by its terms.
This contributing guide is adapted from the tidyverse contributing guide available at https://raw.githubusercontent.com/r-lib/usethis/master/inst/templates/tidy-contributing.md