Skip to content

Commit 3538de5

Browse files
committed
add zarr-extensions repo
1 parent a859a36 commit 3538de5

File tree

1 file changed

+26
-20
lines changed

1 file changed

+26
-20
lines changed

draft/ZEP0009.md

Lines changed: 26 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ nav_order: 9
1010

1111
Authors:
1212

13-
- Norman Rzepka
14-
- Josh Moore
13+
- [Norman Rzepka](https://github.com/normanrz), scalable minds
14+
- [Josh Moore](https://github.com/joshmoore), German BioImaging
1515

1616
Status: Draft
1717

@@ -117,12 +117,12 @@ raw names and URI-based.
117117
1. **Raw names** MUST be assigned within a central repository and follow the
118118
compatibility and versioning [v3 stability
119119
policy](https://zarr-specs.readthedocs.io/en/latest/v3/core/v3.0.html#stability-policy).
120-
The name assignment is managed through the [`zarr-developers` Github
121-
organization](https://github.com/zarr-developers), where each extension is
122-
listed and either contains a spec document or links to a spec document.
123-
Names are never unassigned or reassigned. The ZSC or by delegation a
124-
maintainer team reserves the right to refuse name assignment at its own
125-
discretion.
120+
The name assignment is managed through the [`zarr-extensions` Github
121+
repository](https://github.com/zarr-developers/zarr-extensions), where
122+
each extension is listed and either contains a spec document or links to
123+
a spec document. Names are never unassigned or reassigned. The ZSC or by
124+
delegation a maintainer team reserves the right to refuse name assignment
125+
at its own discretion.
126126

127127
- **Example:** `zstd`
128128
- **Acceptd regex:** `^[a-z0-9-_.]+$`
@@ -189,8 +189,7 @@ There is no strict requirement for extensions to have a formal specification.
189189
However, for adoption in the community it is STRONGLY RECOMMENDED to write a
190190
specification.
191191

192-
For extensions with raw names, there will be a repository under the
193-
`zarr-developers` Github organization to either publish the specifications
192+
For extensions with raw names, there will be the [zarr-extensions](https://github.com/zarr-developers/zarr-extensions) repository to either publish the specifications
194193
directly or link to another location. For extensions with URI-based names, it
195194
is RECOMMENDED to publish the specification under the URI of the extension.
196195

@@ -267,10 +266,10 @@ described above:
267266
#### Community registry
268267

269268
Externally to this ZEP, we will work towards unification of these extension
270-
points. We propose that community register and discuss their extensions on an
271-
additional repository within the zarr-developers organization. We recommend
272-
that a maturity ranking be included in those listings as in other plugin
273-
ecosystems.
269+
points. We propose that community register and discuss their extensions on the
270+
[zarr-extensions](https://github.com/zarr-developers/zarr-extensions) repository.
271+
Eventually, we recommend that a maturity ranking be included in those listings
272+
as in other plugin ecosystems.
274273

275274
#### Reassigning or unassigning names
276275

@@ -285,12 +284,9 @@ beyond checking `must_understand`.
285284

286285
#### Name assignment
287286

288-
Raw names will be assigned through the `zarr-developers` Github organization.
289-
290-
Our first choice would be to have a single, additional repository which can be
291-
maintained by a large number of contributors. This will simplify review and
292-
prevent long-wait times on assginment. The process for updating the
293-
`zarr-specs` repository with these names, if at all, needs to be defined.
287+
Raw names will be assigned through the [`zarr-extension`](https://github.com/zarr-developers/zarr-extensions) repository. While the Zarr steering council will initially maintain
288+
this repository, it is intended that a community team will be formed to maintain
289+
the repository long-term.
294290

295291
An alternative would be to use the `zarr-specs` repository to deposit spec
296292
documents for every assigned name. The process would be that extension
@@ -306,6 +302,16 @@ A third option would be to only store the names of the extensions in
306302
that case, externally hosted could also be another repo under `zarr-developers`
307303
that manages some extensions through its own maintenance structure.
308304

305+
#### Review process
306+
307+
To register an extension with a raw name, a community member needs to open a new
308+
PR in the [zarr-extensions](https://github.com/zarr-developers/zarr-extensions)
309+
repository.
310+
311+
Each extension MUST have a README.md file that describes the extension and its metadata specification. Extensions SHOULD have a schema.json file that contains the JSON schema for the metadata, if the README.md does not provide a link to an external schema. Please note that all extensions documents will be licensed under the Creative Commons Attribution 3.0 Unported License. Only open a PR if you are willing to license your extension under this license.
312+
313+
The PR will be reviewed by the Zarr steering council. We aim to be very open about registering extensions. The review will be done largely based on avoiding confusing extension names and preventing malicious activity as well as maintaining the formal requirements of the extensions. Extension maintainers are responsible for their extensions. Updates to the extensions will also be reviewed by the steering council.
314+
309315
## Phase 2: New extension points
310316

311317
Beyond the immediate clarifications that are outlined in phase 1, we believe

0 commit comments

Comments
 (0)