Skip to content
This repository has been archived by the owner on Oct 17, 2021. It is now read-only.

Latest commit

 

History

History
42 lines (33 loc) · 1.8 KB

CONTRIBUTING.md

File metadata and controls

42 lines (33 loc) · 1.8 KB
Raw

Contributing to rfret

Bug reports

Bugs should be reported here. Before reporting any bug, please make sure it is not already listed as an open issue or already closed issue.

Code contributions

Contributors, please follow this standard workflow:

  1. Fork this repository to your GitHub account.
  2. Use RStudio and open the project through the rfret.Rproj file: this will ensure project-specific settings are applied (indentation, etc.).
  3. Make your modifications starting from my dev branch, and ideally in a branch named after the particular feature or modification you are contributing.
  4. Send a pull request to my dev branch.
  5. Be patient, and don't get upset if I take days to get back to you: I am maintaining this package on my free time.

Also, before submitting a pull request, please check that:

  • in case you modified an interface, you updated its documentation and its unit test, or added an appropriate unit test to cover a new case (covr::report() will indicate what code lacks unit tests);
  • all unit tests pass (use devtools::test());
  • vignettes build without errors (use devtools::build_vignettes());
  • you updated the documentation (use devtools::document());
  • you rebuilt the documentation website (use pkgdown::build_site());
  • devtools::check() finishes with no errors and no warnings (notes are OK, but please explain what caused them in your PR if you get more notes than my dev branch);
  • devtools::install() finishes with no errors and no warnings.