Thank you for contributing!
Reporting Issues
To report a bug or request a feature please open an issue.
Contributing Code
1. Install suggested dependencies
install.packages(c("knitr", "rmarkdown", "roxyglobals", "testthat", "mockery"))
# Additional packages for running checks locally
install.packages(c("devtools", "covr", "styler"))2. Fork the repo and make changes
- Fork the repository and create a branch off of
main. - Ensure changes are covered by tests.
- Update the documentation as needed.
3. Run checks
GitHub Actions will perform linting and run package checks and tests when you push changes. You can also check your code ahead of time:
devtools::load_all()
# Testing
devtools::test()
devtools::run_examples()
covr::package_coverage()
# R CMD check
devtools::check()
# Linting and documentation
styler::style_pkg()
devtools::document()4. When ready, open a pull request (PR)
- Include a clear description of the changes.
- Reference any related issues.
- Make sure all checks pass.