From c106c138103f0841e23d7e66f21735a52755a5d8 Mon Sep 17 00:00:00 2001 From: Chris Barnes Date: Thu, 8 Oct 2026 12:23:09 +0100 Subject: [PATCH 1/2] Contribution guidelines --- README.md | 19 +++++++++++++++++++ 1 file changed, 19 insertions(+) diff --git a/README.md b/README.md index 37b8ab2..790016c 100644 --- a/README.md +++ b/README.md @@ -15,6 +15,12 @@ whose arguments and intended function are specified in this repository. The testing tools then invoke the dingus with one test case at a time, collect the output, and tabulate the implementation's conformance to expectations. +Currenty out of scope for this projects are: + +- examples of real-world data +- benchmarks +- tests for mutation or writing operations + ## Test case layout Test cases are found in the [`cases/`](./cases/) directory. @@ -118,6 +124,19 @@ Run `just pre-commit-install` to install the hooks. CLI functionality is tested using [pytest](https://docs.pytest.org/en/stable/). Run `just test` to run the tests. +### Test case guidelines + +- Cases should represent a minimum reproducible example to exercise a particular feature +- If the feature under test depends on other features, use a configuration from a `valid` test case as a base + +For `validate_zarr` tests: + +- Use Zarr groups instead of arrays where possible, for simplicity +- Minimise the usage of different Zarr features where possible, e.g. + - Use a regular file system store with the default chunk key encoding + - For arrays, use a regular chunk grid with one chunk the same shape as the array + - Do not use any array-to-array or bytes-to-bytes codecs for array data + ### Python version support Some development tooling has tighter python version constraints than `oztest` itself. From 69926f141020567e9612f803618a9d5a4688c7d5 Mon Sep 17 00:00:00 2001 From: Chris Barnes Date: Thu, 8 Oct 2026 12:32:56 +0100 Subject: [PATCH 2/2] recommend a validate_zarr case for each parse_attributes --- README.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/README.md b/README.md index 790016c..bfb3724 100644 --- a/README.md +++ b/README.md @@ -131,6 +131,8 @@ Run `just test` to run the tests. For `validate_zarr` tests: +- Every `parse_attributes` case should have an equivalent `validate_zarr` case + - This may mean adding more Zarr nodes above or below the node with the attributes under test - Use Zarr groups instead of arrays where possible, for simplicity - Minimise the usage of different Zarr features where possible, e.g. - Use a regular file system store with the default chunk key encoding