Thank you for considering contributing to our project! We welcome all contributions that help make this project better for everyone. Please read this guide to understand how you can help and how to do so effectively.
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
.Rfile belowR/. - NO: you edit an
.Rdfile belowman/.
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.
If you find a bug, please open an issue and include:
-
A clear and descriptive title.
-
Steps to reproduce the problem.
-
Expected vs. actual results.
-
Screenshots, if applicable.
-
Information about your environment (e.g., OS, browser, or relevant tool versions).
To suggest a feature or enhancement:
-
Check existing issues to avoid duplicates.
-
Open a new issue with the label
feature request. -
Include:
-
A detailed description of the feature.
-
Use cases and why it would be helpful.
-
- We recommend that you create a Git branch for each pull request (PR).\
- 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. Contributions with test cases included are easier to accept.\
Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.