Skip to contents

Contributing

Contributions are welcome! To get started:

  1. Fork the repo and clone your fork.
  2. Install development dependencies:
   devtools::install_deps(dependencies = TRUE)
  1. Make your changes in R/. If you add or modify exported functions, update the roxygen2 documentation and run:
   devtools::document()
  1. Add tests in tests/testthat/ for any new behavior. Tests that require the r-codecarbon conda environment should use skip_if_not() so they don’t fail in environments without it set up.
  2. Before opening a PR, run:
   devtools::test()
   devtools::check()
  1. Add a bullet to NEWS.md describing your change.
  2. Open a pull request against main describing the change and, if relevant, any validation against codecarbon (see comparison/coverage_matrix.md).

Bug reports and feature requests are welcome via GitHub Issues.