Contributing

Making Changes

This project follows Conventional Commits to allow for Semantic Versioning.

• Conventional commit types explained

Adding new functionality

New functions should have test cases.

usethis::use_r("NEW_FUNCTION_NAME_HERE")
usethis::use_test("NEW_FUNCTION_NAME_HERE")

Changing DESCRIPTION

Cleanup after making changes to DESCRIPTION.

usethis::use_tidy_description()

Preparing your Pull Request

Make sure documentation is up-to-date and checks pass on your machine.

styler::style_pkg()
devtools::document()
devtools::check()