Contributing to broomSource:
This outlines how to propose a change to broom. For more detailed info about contributing to this package, and other tidyverse/tidymodels packages, please see the development contributing guide.
If you are adding new tidiers to broom, be sure to read the vignette on adding tidying methods.
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).
- 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 is not related to your PR.
- We use roxygen2, with Markdown syntax, for documentation.
- We use testthat. Contributions with test cases included are easier to accept. See existing unit tests, like these, for a guide on how to unit test broom tidiers.
- 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).
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.