Skip to contents

Contributing to hte3

Source: CONTRIBUTING.md

Thanks for contributing to hte3.

The repo has two documentation tracks:

  • Standard contributor workflow: setup, tests, docs generation, and release checks
  • Learner extension workflow: how to prototype or package a custom hte3 learner

Start with these guides:

Local workflow

Most changes should update code, tests, and docs together. The usual local loop is:

Rscript -e 'devtools::document()'
Rscript -e 'pkgdown::build_site()'
Rscript -e 'testthat::test_local(stop_on_failure = FALSE)'

If you did not touch roxygen comments, you can skip devtools::document().

Release-oriented checks

Before a release or a docs-heavy merge, also run:

R CMD build .
R CMD check --no-manual hte3_<version>.tar.gz

Use dev/release-checklist.md as the source of truth for the full release sequence.

Website note

The website in docs/ is generated by pkgdown. Do not hand-edit generated HTML. Update README.md, man/, or vignettes/, then rebuild the site:

Rscript -e 'pkgdown::build_site()'

Legacy paper reproducibility

The EP-learner paper reproduction remains available in paper_EPlearner_experiments/, but it is not part of the main user-facing site. Use paper_EPlearner_experiments/install_legacy_paper_repro.R for the frozen package ref and inst/legacy/run_smoke.R for the smoke-test entry point.

Learner contributions

If you are adding a new Lrnr_* class or a new public workflow, also update:

  • tests for fit/predict and validation behavior
  • the relevant workflow vignette
  • README.md
  • _pkgdown.yml when article navigation changes