This outlines how to propose a change to fusen. For more detailed info about contributing to this, and other tidyverse packages, please see the development contributing guide.
We are open to any contribution, from typos to new features. We will guide you throughout the process and make you in a safe position to contribute, whatever is your level in R programming.
Multiple files of the package in “R/”, “tests/” and “vignettes/” are issued from a flat file. When this is the case, you will see this Warning on top of the file:
“# WARNING - Generated by {fusen} from dev/flat_xxx.Rmd: do not edit by hand”
This means that you will need to make your changes in the corresponding flat file, and then inflate() this same flat file. We recommend using fusen::inflate_all() directly so that it takes into account any modification.
This way of developing is what {fusen} is for. We assume that if you contribute to {fusen}, you may already use it. If this is not the case, you can read the Readme of the project on GitHub.
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.
If you want to make a bigger change, it’s a good idea to first file an issue and make sure someone from the team agrees that it’s needed. If you’ve found a bug, please file an issue that illustrates the bug with a minimal reprex (this will also help you write a unit test, if needed).
Fork the package and clone onto your computer. If you haven’t done this before, we recommend using usethis::create_from_github("ThinkR-open/fusen", 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
Open the dev/dev_history.R file: rstudioapi::navigateToFile("dev/dev_history.R") Find the “# Dependencies —-” part and run the attachment::att_amend_desc(...) as presented there. This will update documentation and list of dependencies in DESCRIPTION with the ones needed by {fusen}.
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 fusen project is released with a Contributor Code of Conduct. By contributing to this project you agree to abide by its terms.