Skip to content

Latest commit

 

History

History
35 lines (25 loc) · 718 Bytes

File metadata and controls

35 lines (25 loc) · 718 Bytes

Contributing to tutorizeR

Development setup

  1. Fork and clone the repository.
  2. Install dependencies:
install.packages(c("devtools", "roxygen2", "testthat", "lintr"))
  1. Run checks locally:
devtools::document()
devtools::test()
R CMD build .
R CMD check --as-cran --no-manual tutorizeR_*.tar.gz

Pull request expectations

  • Keep PRs small and atomic.
  • Add or update tests for every behavior change.
  • Update roxygen docs and NEWS entry.
  • Include a minimal reproducible example for new features.

Style

  • Use clear teacher-facing error messages.
  • Prefer explicit validation and defensive checks.
  • Follow tidyverse-style naming and testthat edition 3 conventions.