Contributing

Thank you for spending your time contributing to the ome-zarr-models-py project. We welcome contributions from everyone, no matter how little or large they are! Below are some different ways you can contribute.

Suggesting new features

We're super open to helper functionality for working with OME-Zarr metadata using our package! To suggest a new feature, please open a ticket on our issue tracker.

Reporting issues

If you think you've found an issue or bug with this package, please report it on our issue tracker.

Implementing OME-Zarr RFCs

The request for comment (RFC) process in the OME-Zarr spec allows major changes or additions to be proposed to the specification. We encourage RFC authors to implement OME-Zarr RFCs in this package, as a mechanism to see what the RFC looks like in practice before it is merged.

For every OME-Zarr RFC we will open an issue and a new branch. If you would like to implement an RFC, please comment on that issue so we can avoid duplication of work.

ome-zarr-models will always contain an in-progress implementation of the next version of the OME-Zarr specification. RFC implementations should modify this version. In addition, please open implementation PRs against the RFC branch.

We will review the work as normal, and then merge it into the RFC branch. This means the diff between the RFC branch and the main branch shows the implementation of the RFC. Once RFCs are accepted into the OME-Zarr specification, the RFC branch will be merged, adding support of that RFC to ome-zarr-models.

Contributing code

Setting up a development environment

We use uv for development. To install development dependencies, run uv sync.

Building the docs

We use mkdocs for documentation. mkdocs is auomatically installed as part of the uv development environment. Run mkdocs serve, and open up the URL that your terminal prints.