Skip to content

Commit 8ced876

Browse files
Consolidate the discussion avenues for ZEPs, minor formatting, and add a page for ZIC
1 parent c94640d commit 8ced876

File tree

4 files changed

+74
-34
lines changed

4 files changed

+74
-34
lines changed

active/ZEP0000.md

Lines changed: 30 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -54,15 +54,15 @@ that require collaboration across multiple projects.
5454

5555
## ZEP types
5656

57-
- Specification ZEP
57+
- **Specification ZEP**
5858

5959
Specification ZEPs deal with the changes related to [Zarr Specifications].
6060
The SPEC ZEP (abbreviation of Specification ZEP) for now introduces changes in
6161
the core specification of Zarr. The changes related to core specification follow a
6262
strict and thorough review process and should be adopted by everyone in the
6363
Zarr community.
6464

65-
- Core protocol ZEP
65+
- **Core protocol ZEP**
6666

6767
Describes a ZEP which involves changes in the core specification of Zarr. Core
6868
protocol ZEPs (commonly known as Core ZEPs) are a part of SPEC ZEPs and apply to
@@ -80,14 +80,14 @@ are typically not free to ignore them.
8080
Note: Currently, Specification ZEPs only deal with the core specification of Zarr.
8181
The scope of SPEC ZEPs will be extended in the future.
8282

83-
- Informational ZEP
83+
- **Informational ZEP**
8484

8585
Describes a ZEP design issue or provides general guidelines or information to
8686
the Zarr community but does not propose a new feature. Informational ZEPs do
8787
not necessarily represent Zarr community consensus or recommendation, so users
8888
and implementers are free to ignore informational ZEPS or follow their advice.
8989

90-
- Process ZEP
90+
- **Process ZEP**
9191

9292
Describes a new process around Zarr and its implementations or proposes a
9393
change to (or an event in) a process. They may propose an implementation, but
@@ -130,16 +130,17 @@ mentioned below. This allows the author to flesh out the draft ZEP to make it
130130
properly formatted, of high quality, and address initial concerns about the
131131
proposal.
132132

133-
After the PR for the ZEP is in place, a post should be made on the GitHub
134-
organisation [discussions], containing the sections up to “Backward
135-
compatibility” to limit discussion there to usage and impact. Discussion on the
136-
pull request will have a broader scope, including details of implementation.
133+
After the PR for the ZEP is in place, an issue should be created in the [ZEPs]
134+
repository, containing the sections up to “Backward compatibility” to limit
135+
discussion there to usage and impact. Discussion on the pull request will have
136+
a broader scope, including details of implementation.
137137

138138
Spec ZEPs consist of two parts, a PR to the [zarr-specs] repository containing
139-
changes to the spec and a narrative document explaining the need, importance and
140-
use-case for the change. It is also highly recommended that the specification
141-
ZEP be accompanied by an implementation PR in at least one of the repositories
142-
represented in the [zarr_implementations].
139+
changes to the spec and a PR to the [ZEPs] repository containing a narrative
140+
document explaining the need, importance and use-case for the change. It is
141+
also highly recommended that the specification ZEP be accompanied by an
142+
implementation PR in at least one of the repositories represented in the
143+
[zarr_implementations].
143144

144145
### Submitting a ZEP
145146

@@ -156,7 +157,7 @@ The second PR should contain actual changes and should be submitted in the
156157
four-digit ZEP number from the zarr-developers/zep repository.
157158

158159
For ZEPs other than spec, the proposal should be submitted as a draft ZEP via a
159-
GitHub pull request to the zarr-developers/zep repository with the name
160+
GitHub pull request to the [zarr-developers/zep] repository with the name
160161
`zep-<n>.md` where `<n>` is an appropriately assigned four-digit number (e.g.,
161162
zep-0000.md). The draft ZEP must use the
162163
[ZEP X - Template and Instructions][template.md] file.
@@ -177,13 +178,10 @@ or not taking care of Zarr [CODE OF CONDUCT].
177178

178179
As soon as the draft ZEP is committed to the ZEP repository, the author(s)
179180
should create a discussion thread for the ZEP to provide a central place to
180-
discuss and review its contents. The ZEP author(s) may select the GitHub
181-
discussion feature in the organisation [discussions] or the ZEP repository and
182-
similarly use the discussion feature in the [zarr-specs] repository for
183-
specification ZEPs. Alternatively, the author(s) may open a new issue in the
184-
Zarr [community] repository or start the discussion in the Zarr [Gitter] channel.
185-
The discussion regarding the ZEP should follow Zarr’s [CODE OF CONDUCT] at all
186-
times.
181+
discuss and review its contents. The ZEP author(s) may create an issue in
182+
[ZEPs] repository and or similarly create an issue in [zarr-specs] repository
183+
for specifications ZEPs. The discussion regarding the ZEP should follow Zarr’s
184+
[CODE OF CONDUCT] at all times.
187185

188186
ZEP authors are responsible for collecting community feedback on a ZEP.
189187
However, to avoid long-winded and open-ended discussions, strategies such as
@@ -255,13 +253,13 @@ original and new ZEPs respectively. Process ZEPs may also have a status of
255253
A ZEP is `Accepted` by the consensus of all interested contributors. We need a
256254
concrete way to tell whether the agreement has been reached.
257255

258-
> For Core ZEPs:
256+
**For Core ZEPs**
259257

260258
We believe Core ZEPs are of utmost importance and should follow a thorough
261259
review before acceptance. Core ZEPs introduce changes in the core
262260
specification, which are necessary for every other implementation and everyone
263261
in the general community to follow. The [Zarr Steering Council] and
264-
Implementations Council closely review the Core ZEPs, while the author(s) should
262+
[Zarr Implementations Council] closely review the Core ZEPs, while the author(s) should
265263
simultaneously engage the community in their ZEP at several discussion forums
266264
mentioned previously. The ZSC and ZIC would take community consensus into account
267265
while taking the final decision on the Core ZEPs. Author(s) should ensure that
@@ -286,26 +284,25 @@ included in the discussions. The Core ZEPs are accepted by:
286284
Read more about [Zarr Implementations Council].
287285

288286

289-
> For other ZEPs
287+
**For other ZEPs**
290288

291289
For ZEPs, other than specifications, the author(s) must form a consensus around
292290
their proposal. They may refer to [Discussing a ZEP]( #discussing-a-zep ) section to pick an avenue
293291
for discussion and engaging the community.
294292

295-
When you think ZEP is ready to accept, create a new discussion in [zarr-specs]
296-
for Specifications ZEPs using ‘General’ and in zarr-developers/zep for other
297-
ZEPs and as the category with a subject like:
293+
**When you think ZEP is ready to accept**, create a new issue in [zarr-developers/zep]
294+
with a subject like:
298295

299296
> `Proposal to accept ZEP <number>: <title>`
300297
301-
In the body of your discussion, you should:
298+
**In the body of your discussion**, you should:
302299

303300
- Link to the latest version of ZEP,
304301
- Briefly describe any major points of contention and how they were resolved,
305302
- Include a sentence like: “If there are no substantive objections within 7 days
306303
from this post, then the ZEP will be accepted;
307304

308-
After you create the discussion, you should make sure to link the newly created
305+
After you create the issue, you should make sure to link the newly created
309306
thread in the `Discussion` section of the ZEP, so that people can find it later.
310307

311308
Generally, the ZEP author will be the one to create this post, but anyone can
@@ -320,7 +317,7 @@ There may be a case that a ZEP didn’t attract needed attention towards it, the
320317
engagement from the community is low, and `7 days` pass by. In this case,
321318
the author(s) of the ZEP must make necessary efforts to spread the word about
322319
the ZEP through [Gitter] or using the organisation [discussions] feature of
323-
GitHub or, if needed, creating an additional PR in the [community] repository.
320+
GitHub or, if needed, creating an additional issue in the [community] repository.
324321
In addition, the author(s) should get in touch with the [Zarr Steering Council]
325322
to prevent the case that the ZEP was accepted due to less participation from the
326323
community.
@@ -335,10 +332,10 @@ side of asking for more feedback and looking for opportunities to compromise.
335332

336333
If the final comment period passes without any substantive objections, then the
337334
ZEP can officially be marked `Accepted`. You should create a follow-up
338-
discussion thread in zarr-developers/zep repository notifying everyone
335+
issue in [zarr-developers/zep] repository notifying everyone
339336
(celebratory emoji optional but encouraged 🎉✨), and then update the ZEP by
340337
setting its `:Status:` to `Accepted`, and it's `:Resolution:` header to a link
341-
to your follow-up discussion thread.
338+
to your follow-up discussion (the last issue created) thread.
342339

343340
If there are substantive objections, then the ZEP remains in `Draft` state,
344341
discussion continues as normal, and it can be proposed for acceptance again
@@ -404,7 +401,7 @@ This document has been placed in the public domain.
404401
<!-- governance specific links -->
405402
[CODE OF CONDUCT]: https://github.com/zarr-developers/.github/blob/main/CODE_OF_CONDUCT.md
406403
[Zarr Steering Council]: https://github.com/zarr-developers/governance/blob/main/GOVERNANCE.md#zarr-steering-council
407-
[Zarr Implementations Council]: https://github.com/zarr-developers/governance/blob/main/GOVERNANCE.md#zarr-implementation-council-zic
404+
[Zarr Implementations Council]: https://zarr.dev/zeps/zic/
408405

409406
<!-- github links: capitalization matches that of the repo -->
410407
[community]: https://github.com/zarr-developers/community
@@ -413,3 +410,4 @@ This document has been placed in the public domain.
413410
[zarr-specs]: https://github.com/zarr-developers/zarr-specs
414411
[ZEPs]: https://github.com/zarr-developers/zeps
415412
[https://github.com/zarr-developers/governance/pull/16]: https://github.com/zarr-developers/governance/pull/16
413+
[zarr-developers/zep]: https://github.com/zarr-developers/zeps

join-community.markdown

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
layout: page
2+
layout: default
33
title: join the community
44
permalink: /join-community/
55
---

meetings/meetings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22
layout: default
33
title: ZEP meetings
44
description: Information about bi-weekly ZEP meetings
5-
nav_order: 4
5+
nav_order: 5
66
has_children: true
77
permalink: /meetings/
88
---
Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
layout: default
3+
title: implementations council
4+
description: Representatives of various Zarr Implementations
5+
nav_order: 4
6+
permalink: /zic/
7+
---
8+
9+
# Zarr Implementation Council 🚀
10+
11+
The [ZSC](https://github.com/zarr-developers/governance/blob/main/GOVERNANCE.md#zarr-steering-council) have invited Zarr Implementations to participate in the management of the Zarr specification through the Zarr Implementation Council (ZIC). Implementations are selected based on the maturity of implementation as well as the activity of the developer community. Preference will be given to open-source and *open-process* implementations. Multiple implementations in a single programming language may be invited, or such implementations could work together as a single community.
12+
13+
The current list of implementations which are participating in this process are (in alphabetical order):
14+
15+
- [constantinpape/z5](https://github.com/constantinpape/z5) represented by [Constantin Pape](https://github.com/constantinpape) ([May 2022 – present](https://github.com/zarr-developers/governance/issues/26))
16+
17+
- [google/tensorstore](https://github.com/google/tensorstore) represented by [Jeremy Maitin-Shepard](https://github.com/jbms) ([May 2022 – present](https://github.com/zarr-developers/governance/issues/22))
18+
19+
- [freeman-lab/zarr-js](https://github.com/freeman-lab/zarr-js) represented by [Jeremy Freeman](https://github.com/freeman-lab) ([May 2022 – present](https://github.com/zarr-developers/governance/issues/27))
20+
21+
- [gzuidhof/zarr.js](https://github.com/gzuidhof/zarr.js) represented by [Trevor Manz](https://github.com/manzt) ([May 2022 – present](https://github.com/zarr-developers/governance/issues/28))
22+
23+
- [JuliaIO/Zarr.jl](https://github.com/JuliaIO/Zarr.jl) represented by [Fabian Gans](https://github.com/meggart) ([May 2022 – present](https://github.com/zarr-developers/governance/issues/18))
24+
25+
- [saalfeldlab/n5-zarr](https://github.com/saalfeldlab/n5-zarr) represented by [Stephan Saalfeld](https://github.com/axtimwalde) ([May 2022 – present](https://github.com/zarr-developers/governance/issues/25))
26+
27+
- [sci-rs/zarr](https://github.com/sci-rs/zarr) represented by [Andrew Champion](https://github.com/aschampion) ([May 2022 - present](https://github.com/zarr-developers/governance/issues/20))
28+
29+
- [Unidata/netcdf-c](https://github.com/Unidata/netcdf-c) and [Unidata/netcdf-java](https://github.com/Unidata/netcdf-java) represented by [Ward Fisher](https://github.com/wardf) ([May 2022 - present](https://github.com/zarr-developers/governance/issues/21))
30+
31+
- [xtensor-stack/xtensor-zarr](https://github.com/xtensor-stack/xtensor-zarr) represented by [David Brochart](https://github.com/davidbrochart) ([May 2022 - present](https://github.com/zarr-developers/governance/issues/23))
32+
33+
- [zarr-developers/zarr-python](https://github.com/zarr-developers/zarr-python) represented by [Gregory Lee](https://github.com/grlee77) ([May 2022 - present](https://github.com/zarr-developers/governance/issues/19))
34+
35+
36+
The core developers of each implementation have selected a representative of the ZIC. It is up to each implementation to determine its process for selecting its representatives.
37+
38+
This member will represent that implementation in decisions regarding the Zarr Specification and other Zarr-wide contexts which require input from implementations.
39+
40+
An additional representative should also be selected to act as an alternate when the primary representative is unavailable.
41+
42+
Continued ZIC membership depends on timely feedback and votes on relevant issues. The ZSC also reserves the right to remove implementations from the council.

0 commit comments

Comments
 (0)