Skip to contents

Contributing to pizzarr

Source: CONTRIBUTING.md

Development Setup

setwd("path/to/pizzarr")
install.packages("devtools")
devtools::install()
devtools::load_all()

Testing

Tests run single-threaded (Config/testthat/parallel: false in DESCRIPTION).

devtools::check()
devtools::test()

Building Documentation

devtools::document()
pkgdown::build_site()

Coding Conventions

  • Style: snake_case everywhere (functions, methods, variables). 2-space indent.
  • Errors: stop("ErrorName(details)") — mimics Python Zarr error names. No rlang.
  • Warnings/info: warning() and message() from base R.
  • Assertions: direct if (...) stop() — no assertion library.
  • R6 docs: roxygen2 with @title, @docType class, @format [R6::R6Class]. See r6-roxygen-convention.md for the full style guide.
  • Tests: testthat 3e with test_that("description", { ... }).

Resources