Thanks for your interest in contributing. This repository is the R package. The C++ engine it compiles lives in ppforest2-core and is vendored here under src/core/.
Reporting issues
- Search the issue tracker first to avoid duplicates.
- For bugs, please include a minimal reproducible example (a reprex) and the output of
sessionInfo()orsessioninfo::session_info(). - For a question about usage rather than a bug, feel free to open an issue labelled “question”.
Pull requests
- Open an issue describing the change before starting substantial work, so we can agree on the approach.
- Fork the repository and create a branch off
main. - Changes to the C++ core go to ppforest2-core, not to
src/core/orinst/golden/here. Both are copies refreshed withmake vendor-core. - Follow the existing code style. R code follows the tidyverse style guide; C++ code is formatted with
clang-format(make format). - Add tests for any behaviour you change or add. Tests use testthat under
tests/testthat/. - Run the test suite with
make testand the full package check withmake checkbefore submitting. Add an entry toNEWS.mdin the same commit as a user-facing change. - Keep documentation in sync: R docs are generated from
roxygen2blocks (make document); never hand-editNAMESPACEor files underman/.
Code of Conduct
By participating in this project you agree to abide by its Code of Conduct.