Contributing
Contributions are welcome! To get started:
- Fork the repo and clone your fork.
- Install development dependencies:
devtools::install_deps(dependencies = TRUE)- Make your changes in
R/. If you add or modify exported functions, update the roxygen2 documentation and run:
devtools::document()- Add tests in
tests/testthat/for any new behavior. Tests that require ther-codecarbonconda environment should useskip_if_not()so they don’t fail in environments without it set up. - Before opening a PR, run:
devtools::test()
devtools::check()- Add a bullet to
NEWS.mddescribing your change. - Open a pull request against
maindescribing the change and, if relevant, any validation againstcodecarbon(seecomparison/coverage_matrix.md).
Bug reports and feature requests are welcome via GitHub Issues.
