Skip to contents

First off, thanks for taking the time to contribute! All contributions are welcome, from reporting a bug to proposing a new feature or improving the documentation.

Report bugs or request features

Report bugs and request features at https://github.com/b-cubed-eu/invasimapr/issues.

When reporting a bug, please include:

  • Your operating system name and version, and your R session info (sessionInfo()).
  • A minimal, self-contained, reproducible example (a “reprex”).
  • Detailed steps to reproduce the problem and what you expected to happen.

Contribute code

We use the standard GitHub flow:

  1. Fork the repository and create a branch from main.
  2. Make your changes, following the B-Cubed software development guide and the tidyverse style guide.
  3. Add or update unit tests (testthat) and roxygen2 documentation (@return and @examples for exported functions).
  4. Run devtools::document(), devtools::test() and devtools::check() locally and make sure they pass without errors.
  5. Open a pull request describing your changes and referencing any related issues.

Code of conduct

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.