πŸ”¨ DevelopmentΒΆ

Contributions are welcome and appreciated!

We are glad you are here and appreciate your contribution. Please keep in mind our community participation guidelines.

Get the source codeΒΆ

git clone https://github.com/thewtex/ngff-zarr
cd ngff-zarr

Install dependenciesΒΆ

First install pixi. Then, install project dependencies:

pixi install -a
pixi run pre-commit-install

Run the test suiteΒΆ

pixi run test

Build the documentationΒΆ

If needed, build and update the documentation:

pixi run dev-docs

Update test dataΒΆ

If needed, update the testing data.

  1. Generate new test data tarball and compute its sha256 hash

pixi run hash-data
  1. Upload the data to web3.storage

  2. Upload the test_data_ipfs_cid (from web3.storage web UI) and test_data_sha256 (sh256sum ../data.tar.gz) variables in test/_data.py.

Submit the patchΒΆ

We use the standard GitHub flow.