Skip to contents

Contributing to symbolizer

Source: CONTRIBUTING.md

symbolizer is pre-CRAN and pre-1.0. Contributions are welcome but should respect the package’s pace and scope.

Definition of Done

A change is “done” when all of the following are true:

  • Implementation: code lives in a R/*.R file matching the existing kebab-case naming.
  • Tests: at least one test in tests/testthat/test-*.R. Snapshot tests for any LaTeX or rendered output.
  • Documentation: roxygen2 block with @param, @return, and at least one @examples block.
  • Capability registry: any new (class, family, component) tuple is added to inst/extdata/capabilities.csv with one of the five status words (Stable / First slice / Opt-in control / Planned or reserved / Unsupported or blocked).
  • Templates over splicing: any new user-facing prose is added as a row in inst/extdata/*.csv. Do not write string-spliced sentences in R/.
  • Local checks: devtools::check() is clean on macOS or Linux.
  • Design link: if the change touches the symbolized_model structure or a renderer’s public output, reference the relevant section of the design plan.

Local development

devtools::load_all()
devtools::test()
devtools::check()
devtools::document()
pkgdown::build_site()

Prefer local checks over CI. The CI workflow runs Linux-only on PR and workflow_dispatch.

Reporting issues

Issues at https://github.com/itchyshin/symbolizer/issues. Please include a minimal reproducible example.