Skip to content

Latest commit

 

History

History
47 lines (34 loc) · 2.22 KB

README.md

File metadata and controls

47 lines (34 loc) · 2.22 KB
Raw

Zarr Enhancement Proposals (ZEPs)

Community Feedback Process for Zarr Specifications

ZEP stands for Zarr Enhancement Proposal. A ZEP is a design document providing information to the Zarr community, describing a modification or enhancement of the Zarr specifications or a new feature for its processes or environment. The ZEP should provide specific proposed changes to the Zarr specification and a narrative rationale for the specification changes.

We intend ZEPs to be the primary mechanism for evolving the spec, collecting community input on significant issues and documenting the design decision that has gone into Zarr.

Proposing a new ZEP

ZEPs should be submitted as a draft ZEP in the draft folder of this (zeps) repository via GitHub pull request.

The PR should contain the narrative text of the ZEP with the name zep-<n>.md where <n> is an appropriately assigned four-digit number. The draft ZEP must use the ZEP X - Template and Instructions file.

To read more on Submitting a ZEP, please refer here.

Contributing to ZEPs

The ZEPs in this repo are published automatically on the web @ https://zarr.dev/zeps/. If you wish to contribute to the website, please build the website locally on your machine. Building this website requires Jekyll. Refer to this to install Jekyll.

Steps to contribute:

  1. Fork this repo
  2. cd into the forked repo
  3. Type bundle exec jekyll serve --incremental or docker run -p 4000:4000 -v $(pwd):/site bretfisher/jekyll-serve
  4. Open a browser and go to http://localhost:4000/zeps/ to see the website
  5. Make desired changes, save them and refresh http://localhost:4000/zeps/ to see the changes

Once done, push your changes to your fork and open a GitHub pull request.