Skip to content

Latest commit

 

History

History
26 lines (22 loc) · 1.23 KB

CONTRIBUTING.md

File metadata and controls

26 lines (22 loc) · 1.23 KB

Contributing:

First, thanks for considering a contribution! I hope to make this package a community created resource for us all to gain from and won’t be able to do that without your help!

  1. Contributions should be thoroughly tested with testthat.
  2. Code style should attempt to follow the tidyverse style guide.
  3. Please attempt to describe what you want to do prior to contributing by submitting an issue.
  4. Please follow the typical github fork - pull-request workflow.
  5. Make sure you use roxygen and run Check before contributing. More on this front as the package matures.
  6. hydroloom uses tidyselection and data masking. Please review the list of hydroloom global attribute in R/00_hydroloom.R before contributing. They are used as package variables in tidy selection broadly.

Other notes: - consider running lintr prior to contributing. - consider running goodpractice::gp() on the package before contributing. - consider running devtools::spell_check() if you wrote documentation. - this package uses pkgdown. Running pkgdown::build_site() will refresh it.