From 928f7daad3a40e0cf74b243650921754e5d014e3 Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Wed, 7 Feb 2024 16:36:02 +0100 Subject: [PATCH 1/6] Add clarifications from Will and Matt --- rfc/x/index.md | 9 +++++++-- 1 file changed, 7 insertions(+), 2 deletions(-) diff --git a/rfc/x/index.md b/rfc/x/index.md index feb01f99..e09927fa 100644 --- a/rfc/x/index.md +++ b/rfc/x/index.md @@ -137,15 +137,20 @@ The DRAFT phase begins when **Authors** propose (D1) a new idea and subsequently gather support (or "socialize") the idea (D2) before opening a PR (D3). This phase is meant to promote ideation without premature criticism, though clarifications can be requested on the GitHub PR (D4) which may require an -update of the PR (D3). +update of the PR (D3). Note: the RFC process does not formally make use of GitHub's +"draft" state, though **Editors** MAY choose to ignore such PRs. -One potential clarification is whether or not a given PR should be an RFC. The +One common clarification is whether or not a given PR should be an RFC. The RFC process is intended primarily for significant and/or breaking changes to the specification or the community process itself. Other changes, bug fixes, etc. are welcome as PRs without a full RFC. If **Authors** are unsure whether or not a change requires an RFC, they can open an issue or contact the **Editors** directly. All RFC-targeted PRs SHOULD follow the [current template][tmpl]. +Comments on how a specification is implemented or what could be proposed +instead from potential **Reviewers** and **Commenters** should come in the +RFC stage, and the **Editor** MAY postpone such discussions when appropriate. + > 🕑 The iterative clarification phase should be limited to at most a month. At the **Editors** discretion (D5), the PR can be merged at which point it From d2675475d74a6e1c5ab8b6cc265f18f5b052c31d Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Wed, 7 Feb 2024 16:42:01 +0100 Subject: [PATCH 2/6] Rename RFC-x to RFC-1 --- rfc/{x => 1}/diagram.png | Bin rfc/{x => 1}/index.md | 2 +- rfc/{x => 1}/template.md | 0 rfc/process.rst | 8 ++++---- 4 files changed, 5 insertions(+), 5 deletions(-) rename rfc/{x => 1}/diagram.png (100%) rename rfc/{x => 1}/index.md (99%) rename rfc/{x => 1}/template.md (100%) diff --git a/rfc/x/diagram.png b/rfc/1/diagram.png similarity index 100% rename from rfc/x/diagram.png rename to rfc/1/diagram.png diff --git a/rfc/x/index.md b/rfc/1/index.md similarity index 99% rename from rfc/x/index.md rename to rfc/1/index.md index e09927fa..52235638 100644 --- a/rfc/x/index.md +++ b/rfc/1/index.md @@ -1,4 +1,4 @@ -RFC-x +RFC-1 ===== ## Status diff --git a/rfc/x/template.md b/rfc/1/template.md similarity index 100% rename from rfc/x/template.md rename to rfc/1/template.md diff --git a/rfc/process.rst b/rfc/process.rst index db9f26a5..6f7baca4 100644 --- a/rfc/process.rst +++ b/rfc/process.rst @@ -5,14 +5,14 @@ RFC Process :maxdepth: 1 :hidden: - x/template + 1/template -The RFC process is defined in `RFC-x `_ +The RFC process is defined in `RFC-1 <1/index.html>`_ and anyone interested in participating in the RFC process should familiarize themselves with that text. -A `template `_ is available for the +A `template <1/template.html>`_ is available for the creation of new RFCs. The diagram below shows the stages that an RFC progresses through. -.. image:: x/diagram.png +.. image:: 1/diagram.png :alt: Process Diagram From cbd238da04a34f680fa741f36eff5d1dc4ac9f3a Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Wed, 7 Feb 2024 16:47:49 +0100 Subject: [PATCH 3/6] Link to phases --- rfc/process.rst | 12 +++++++++++- 1 file changed, 11 insertions(+), 1 deletion(-) diff --git a/rfc/process.rst b/rfc/process.rst index 6f7baca4..a2660ef2 100644 --- a/rfc/process.rst +++ b/rfc/process.rst @@ -10,8 +10,18 @@ RFC Process The RFC process is defined in `RFC-1 <1/index.html>`_ and anyone interested in participating in the RFC process should familiarize themselves with that text. + +Relevant sections describing the phases depicted in +the diagram below include: + + * `DRAFT <1/index.html#draft>`_ + * `RFC <1/index.html#rfc>`_ + * `SPEC <1/index.html#spec>`_ + A `template <1/template.html>`_ is available for the -creation of new RFCs. The diagram below shows the +creation of new RFCs. + +The diagram below shows the stages that an RFC progresses through. .. image:: 1/diagram.png From a18d82128e8b903fbd8a645c410c8672856387ee Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Wed, 7 Feb 2024 18:04:00 +0100 Subject: [PATCH 4/6] Simple introduction for the rfc/ page --- rfc/index.rst | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/rfc/index.rst b/rfc/index.rst index 00e10d3c..39b943ef 100644 --- a/rfc/index.rst +++ b/rfc/index.rst @@ -5,3 +5,14 @@ RFCs listing process + + +Requests for comments (RFCs) are used to discuss and capture +high-level decisions within the NGFF community. Throughout +the `specifications themselves <../specifications/>`_, +RFCs can be referenced to provide readers further background reading. +For example, `RFC-1 <1/>`_ defines the process in detail, but an overview +is available under `Process `_. Authors interested in +creating an RFC should take a look through +the `listing `_ of current RFCs as well as the +`template <1/template.html>`_ which should be copied and modified. From 95616b71434526c53f27cbc172e60d72928c1cd3 Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Wed, 7 Feb 2024 18:09:37 +0100 Subject: [PATCH 5/6] Clarify that 'Author' is a valid status --- rfc/1/index.md | 4 +++- rfc/1/template.md | 20 ++++++++++---------- 2 files changed, 13 insertions(+), 11 deletions(-) diff --git a/rfc/1/index.md b/rfc/1/index.md index 52235638..05384ad6 100644 --- a/rfc/1/index.md +++ b/rfc/1/index.md @@ -1,13 +1,15 @@ RFC-1 ===== +Definition of the NGFF RFC process + ## Status This RFC is currently under review (D4). | Name | GitHub Handle | Institution | Date | Status | |------------|---------------|-------------------|------------|--------| -| Josh Moore | joshmoore | German BioImaging | 2023-12-23 | | +| Josh Moore | joshmoore | German BioImaging | 2023-12-23 | Author | ## Overview diff --git a/rfc/1/template.md b/rfc/1/template.md index dca5b20d..1513754b 100644 --- a/rfc/1/template.md +++ b/rfc/1/template.md @@ -6,16 +6,16 @@ Summary: Sentence fragment summary Brief description of status, including, e.g., `WIP | In-Review | Approved | Withdrawn | Obsolete`. -| Name | GitHub Handle | Institution | Date | Status | -|-----------|---------------|-------------|------------|----------------------------------| -| Author | N/A | N/A | xxxx-xx-xx | | -| Author | N/A | N/A | xxxx-xx-xx | Implemented (link to release) | -| Commenter | N/A | N/A | xxxx-xx-xx | Endorse (link to comment) | -| Commenter | N/A | N/A | xxxx-xx-xx | Not yet (link to comment) | -| Endorser | N/A | N/A | xxxx-xx-xx | Endorse (no link needed) | -| Endorser | N/A | N/A | xxxx-xx-xx | Implementing (link to branch/PR) | -| Reviewer | N/A | N/A | xxxx-xx-xx | Endorse (link to comment) | -| Reviewer | N/A | N/A | xxxx-xx-xx | Requested by editor | +| Name | GitHub Handle | Institution | Date | Status | +|-----------|---------------|-------------|------------|----------------------------------------| +| Author | N/A | N/A | xxxx-xx-xx | Author | +| Author | N/A | N/A | xxxx-xx-xx | Author; Implemented (link to release) | +| Commenter | N/A | N/A | xxxx-xx-xx | Endorse (link to comment) | +| Commenter | N/A | N/A | xxxx-xx-xx | Not yet (link to comment) | +| Endorser | N/A | N/A | xxxx-xx-xx | Endorse (no link needed) | +| Endorser | N/A | N/A | xxxx-xx-xx | Implementing (link to branch/PR) | +| Reviewer | N/A | N/A | xxxx-xx-xx | Endorse (link to comment) | +| Reviewer | N/A | N/A | xxxx-xx-xx | Requested by editor | ## Overview From 03c734067e1e822d84884f3859d429712609547e Mon Sep 17 00:00:00 2001 From: Josh Moore Date: Wed, 21 Feb 2024 19:07:36 +0100 Subject: [PATCH 6/6] Replace remaining 'x' --- rfc/listing.csv | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rfc/listing.csv b/rfc/listing.csv index 134f8d74..4c7b0488 100644 --- a/rfc/listing.csv +++ b/rfc/listing.csv @@ -1,3 +1,3 @@ RFC,Description,Date,Status `0 <0/index.html>`_,Original consensus model for decision making,2021, -`x `_,RFC Process Proposal,2024, +`1 <1/index.html>`_,RFC Process Proposal,2024,