This outlines how to propose a change to simplerfit. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.
Report bugs at: https://github.com/UBC-MDS/simplerfit/issues.
If you are reporting a bug, please include: 1. Your operating system name and version. 2. Any details about your local setup that might be helpful in troubleshooting. 3. Detailed steps to reproduce the bug.
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.
The best way to send feedback is to file an issue at https://github.com/UBC-MDS/simplerfit/issues.
If you are proposing a feature: 1. Explain in detail how it would work. 2. Keep the scope as narrow as possible, to make it easier to implement.
Fork the package and clone onto your computer. If you haven’t done this before, we recommend using usethis::create_from_github("UBC-MDS/simplerfit", fork = TRUE).
Install all development dependences 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.
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 for unit tests. Contributions with test cases included are easier to accept.
Please note that the simplerfit project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.