mirror of https://github.com/zcash/zips.git
Revise zip-0000.rst for new ZIP editors and processes
This commit is contained in:
teor
Deirdre Connolly
parent
af1c8e3cca
commit
37a8a3b081
131
zip-0000.rst
131
zip-0000.rst
|
|
@ -3,10 +3,13 @@
|
|||
ZIP: 0
|
||||
Title: ZIP Process
|
||||
Owners: Daira Emma Hopwood <daira@electriccoin.co>
|
||||
Deirdre Connolly <deirdre@zfnd.org>
|
||||
teor <teor@zfnd.org>
|
||||
Jack Grigg <str4d@electriccoin.co>
|
||||
Conrado Gouvea <conrado@zfnd.org>
|
||||
Original-Authors: Daira Emma Hopwood
|
||||
Josh Cincinnati
|
||||
George Tankersley
|
||||
Deirdre Connolly
|
||||
Credits: Luke Dashjr
|
||||
Status: Active
|
||||
Category: Process
|
||||
|
|
@ -166,51 +169,88 @@ ZIP Editors
|
|||
The current ZIP Editors are:
|
||||
- Daira Emma Hopwood and Jack Grigg (representing the Electric Coin
|
||||
Company)
|
||||
- Deirdre Connolly, teor, and Conrado Gouvea (representing the Zcash Foundation).
|
||||
- teor and Conrado Gouvea (representing the Zcash Foundation).
|
||||
|
||||
All can be reached at zips@z.cash. The current design of the ZIP Process
|
||||
dictates that there are always at least two ZIP Editors: at least one from the
|
||||
Electric Coin Company and at least one from the Zcash Foundation. Additional Editors may
|
||||
be selected by consensus among the current Editors.
|
||||
Electric Coin Company and at least one from the Zcash Foundation.
|
||||
|
||||
Additional Editors may be selected by consensus among the current Editors.
|
||||
An Editor may be removed or replaced by consensus among the current Editors.
|
||||
However, if the other ZIP editors have consensus, an Editor can not prevent their own removal.
|
||||
Any Editor can resign by informing the other Editors in writing.
|
||||
|
||||
Whenever the ZIP editors change, the new ZIP editors should:
|
||||
- review this ZIP to make sure it reflects current practice,
|
||||
- update the owners of this ZIP,
|
||||
- review ZIP editor access to the `ZIPs repository <https://github.com/zcash/zips>`,
|
||||
- update the <zips@z.cash> email alias, and
|
||||
- invite new editors to the Zcash Community Forums, and the #zips channel on Discord.
|
||||
|
||||
If it has been at least 12 months since the last ZIP editor change, the ZIP editors should:
|
||||
- review this ZIP to make sure it reflects current practice.
|
||||
|
||||
|
||||
ZIP Editor Responsibilities & Workflow
|
||||
--------------------------------------
|
||||
ZIP Editor Responsibilities
|
||||
---------------------------
|
||||
|
||||
The ZIP Editors subscribe to the `Zcash Community Forum.
|
||||
<https://forum.zcashcommunity.com/>`__
|
||||
|
||||
For each new ZIP that comes in, a ZIP Editor confirms the following:
|
||||
Each new ZIP SHOULD be submitted as a "pull request" to the ZIPs git
|
||||
repository [#zips-repo]_. It SHOULD NOT contain a ZIP number unless
|
||||
one had already been assigned by the ZIP Editors. The pull request
|
||||
SHOULD initially be marked as a Draft. The ZIP content SHOULD be
|
||||
submitted in RST format. Generating HTML for a ZIP is optional.
|
||||
|
||||
For each new ZIP that comes in, the ZIP Editors will:
|
||||
|
||||
* Read the ZIP to check if it is ready: sound and complete. The ideas
|
||||
must make technical sense, even if they don't seem likely to be
|
||||
accepted.
|
||||
* The title should accurately describe the content.
|
||||
* The ZIP draft must have been sent to the Zcash Community Forum or as
|
||||
* The ZIP draft must have been sent to the Zcash Community Forum and as
|
||||
a PR to the ZIPs git repository [#zips-repo]_.
|
||||
* Motivation and backward compatibility (when applicable) must be
|
||||
addressed.
|
||||
* The licensing terms are acceptable for ZIPs.
|
||||
|
||||
If the ZIP isn't ready, the editor will send it back to the Owners for
|
||||
revision, with specific instructions.
|
||||
Reviewing a ZIP
|
||||
---------------
|
||||
|
||||
Once the ZIP is ready for the repository it SHOULD be submitted as a
|
||||
"pull request" to the ZIPs git repository [#zips-repo]_ where it may
|
||||
get further feedback. It SHOULD NOT contain a ZIP number unless one
|
||||
had already been assigned by the ZIP Editors. The pull request SHOULD
|
||||
initially be marked as a Draft.
|
||||
Any ZIP Editor can suggest changes to a ZIP. These suggestions are the
|
||||
opinion of the individual ZIP Editor. ZIP Editors are expected to perform
|
||||
independent technical and process review, regardless of contractural or
|
||||
any other relationships.
|
||||
|
||||
The ZIP Editors will:
|
||||
ZIP Owners can clarify, modify, or decline suggestions from ZIP Editors.
|
||||
|
||||
Typically, the ZIP Editors suggest changes in two phases:
|
||||
- `content review`: multiple ZIP Editors discuss the ZIP, and suggest
|
||||
changes to the overall content. This is a "big picture" review.
|
||||
- `format review`: one or two ZIP Editors do a detailed review of the
|
||||
structure and format of the ZIP. This ensures the ZIP is consistent
|
||||
with other Zcash specifications.
|
||||
|
||||
If the ZIP isn't ready, the Editors will send it back to the Owners for
|
||||
revision, with specific instructions. This decision is made by consensus
|
||||
among the current Editors.
|
||||
|
||||
When a ZIP is ready, the ZIP Editors will:
|
||||
|
||||
* Assign a ZIP number in the pull request.
|
||||
* Regenerate the corresponding HTML documents, if required.
|
||||
* Remove Draft status and merge the pull request when it is ready.
|
||||
|
||||
The ZIP editors monitor ZIP changes and update ZIP headers as
|
||||
appropriate.
|
||||
|
||||
The ZIP Editors MAY reject a proposed ZIP or update to an existing ZIP
|
||||
for any of the following reasons:
|
||||
Rejecting a proposed ZIP
|
||||
------------------------
|
||||
|
||||
The ZIP Editors MAY reject a proposed ZIP or update to an existing ZIP,
|
||||
by consensus among the current Editors. Rejections can be based on any
|
||||
of the following reasons:
|
||||
|
||||
* it violates the Zcash Code of Conduct [#conduct]_ ;
|
||||
* it appears too unfocused or broad;
|
||||
|
|
@ -259,13 +299,35 @@ without an explanation.
|
|||
Note that it is not the primary responsibility of the ZIP Editors to
|
||||
review proposals for security, correctness, or implementability.
|
||||
|
||||
Please send all ZIP-related communications either by email to
|
||||
<zips@z.cash>, or by opening an issue on the `ZIPs issue
|
||||
tracker <https://github.com/zcash/zips/issues>`__. All communications
|
||||
should abide by the Zcash Code of Conduct [#conduct]_
|
||||
and follow `the GNU Kind Communication
|
||||
Guidelines <https://www.gnu.org/philosophy/kind-communication.en.html>`__
|
||||
Communicating with the ZIP Editors
|
||||
----------------------------------
|
||||
|
||||
Please send all ZIP-related communications either:
|
||||
- by email to <zips@z.cash>,
|
||||
- by opening an issue on the `ZIPs issue tracker <https://github.com/zcash/zips/issues>`, or
|
||||
- by sending a message in the `#zips channel on the Zcash R&D Discord <https://discord.com/channels/809218587167293450/809251050741170187>`.
|
||||
|
||||
__All communications should abide by the Zcash Code of Conduct [#conduct]_
|
||||
and follow `the GNU Kind Communication
|
||||
Guidelines <https://www.gnu.org/philosophy/kind-communication.en.html>`.__
|
||||
|
||||
ZIP Editor Meeting Practices
|
||||
----------------------------
|
||||
|
||||
The ZIP Editors should meet on a regular basis to review draft changes to
|
||||
ZIPs. Meeting times are agreed by rough consensus among the current ZIP Editors.
|
||||
A ZIP Editor meeting can be held even if some ZIP Editors are not available, but
|
||||
all Editors should be informed of the decisions that will be made at upcoming
|
||||
meetings.
|
||||
|
||||
The ZIP Editors will appoint a ZIP Secretary, which can be a shared or rotating
|
||||
role. The ZIP Secretary will:
|
||||
- share a draft agenda with the ZIP Editors at least 24 hours before each ZIP Editors meeting,
|
||||
- share draft minutes with the ZIP Editors in the week after the ZIP Editors meeting, and
|
||||
- share significant ZIP changes on the Zcash Community Forums.
|
||||
|
||||
If the draft agenda is empty, any ZIP Editor can submit agenda items, or suggest
|
||||
that the meeting is cancelled.
|
||||
|
||||
ZIP format and structure
|
||||
========================
|
||||
|
|
@ -515,12 +577,14 @@ ZIP Status Field
|
|||
once rough consensus is reached in PR/forum posts from Draft Process ZIP.
|
||||
|
||||
* Proposed: Typically the stage after Draft, added to a ZIP after
|
||||
consideration, feedback, and rough consensus from the community. The ZIP
|
||||
Editors must validate this change before it is approved.
|
||||
consideration, feedback, and rough consensus from the community.
|
||||
The Proposed status is approved by consensus among the current ZIP
|
||||
Editors.
|
||||
|
||||
* Rejected: The status when progress hasn't been made on the ZIP in one
|
||||
year. Can revert back to Draft/Proposed if the Owner resumes work
|
||||
or resolves issues preventing consensus.
|
||||
or resolves issues preventing consensus. The Rejected status is
|
||||
approved by consensus among the current ZIP Editors.
|
||||
|
||||
* Implemented: When a Consensus or Standards ZIP has a working
|
||||
reference implementation but before activation on the Zcash network.
|
||||
|
|
@ -541,12 +605,10 @@ Draft or Withdrawn.
|
|||
|
||||
A ZIP may only change status from Draft (or Rejected) to Proposed, when
|
||||
the Owner deems it is complete and there is rough consensus on the
|
||||
forums, validated by both the Electric Coin Company and Zcash Foundation
|
||||
Editors. One Editor will not suffice — there needs to be consensus
|
||||
among the Editors. If it's a Consensus ZIP, a Deployment section MUST
|
||||
be present in order for the ZIP to change status to Proposed. Typically,
|
||||
although not necessarily, this will specify a network upgrade in which
|
||||
the consensus change is to activate.
|
||||
forums, validated by consensus among the current ZIP Editors. If it's a
|
||||
Consensus ZIP, a Deployment section MUST be present in order for the ZIP
|
||||
to change status to Proposed. Typically, although not necessarily, this
|
||||
will specify a network upgrade in which the consensus change is to activate.
|
||||
|
||||
A Standards ZIP may only change status from Proposed to Implemented once
|
||||
the Owners provide an associated reference implementation, typically in
|
||||
|
|
@ -560,7 +622,8 @@ status, upon request by any person, if they have not made progress in
|
|||
one year. Such a ZIP may be changed to Draft status if the Owner
|
||||
provides revisions that meaningfully address public criticism of the
|
||||
proposal, or to Proposed status if it meets the criteria required as
|
||||
described in the previous paragraphs.
|
||||
described in the previous paragraphs. Rejections are applied by consensus
|
||||
among the current ZIP Editors.
|
||||
|
||||
A Consensus or Standards ZIP becomes Final when its associated network
|
||||
upgrade or other protocol change is activated on Zcash's mainnet.
|
||||
|
|
|
|||
Loading…
Reference in New Issue