In a stable state of development, with some degree of active subsequent development as envisioned by the primary authors.
Contributions to cat2cat are welcome! Please read this documentation before proceeding.
You can fix typos, spelling mistakes, or grammatical errors in the documentation directly using the GitHub web interface, as long as the changes are made in the source file. This generally means you’ll need to edit roxygen2 comments in an .R, not a .Rd file. You can find the .R file that generates the .Rd by reading the comment in the first line.
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.
Fork the package and clone onto your computer. If you haven’t done this before, we recommend using usethis::create_from_github("{{github_spec}}", fork = TRUE).
Install all development dependencies with devtools::install_dev_deps(), and then make sure the package passes R CMD check by running devtools::check(). If R CMD check doesn’t pass cleanly, it’s a good idea to ask for help before continuing.
Create a Git branch for your pull request (PR). We recommend using usethis::pr_init("brief-description-of-change").
Make your changes, commit to git, and then create a PR by running usethis::pr_push(), and following the prompts in your browser. The title of your PR should briefly describe the change. The body of your PR should contain Fixes #issue-number.
For user-facing changes, add a bullet to the top of NEWS.md (i.e. just below the first header). Follow the style described in https://style.tidyverse.org/news.html.
Email the person listed as maintainer in the DESCRIPTION file of this repo.
Though note that private discussions over email don’t help others because of the lack of transparency - 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