Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

RFC-1 updates #229

Merged
merged 6 commits into from
Feb 21, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
File renamed without changes
15 changes: 11 additions & 4 deletions rfc/x/index.md → rfc/1/index.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,15 @@
RFC-x
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

Expand Down Expand Up @@ -137,15 +139,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
Expand Down
20 changes: 10 additions & 10 deletions rfc/x/template.md → rfc/1/template.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
11 changes: 11 additions & 0 deletions rfc/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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 <process/>`_. Authors interested in
creating an RFC should take a look through
the `listing <listing.html>`_ of current RFCs as well as the
`template <1/template.html>`_ which should be copied and modified.
2 changes: 1 addition & 1 deletion rfc/listing.csv
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
RFC,Description,Date,Status
`0 <0/index.html>`_,Original consensus model for decision making,2021,
`x <x/index.html>`_,RFC Process Proposal,2024,
`1 <1/index.html>`_,RFC Process Proposal,2024,
20 changes: 15 additions & 5 deletions rfc/process.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,24 @@ RFC Process
:maxdepth: 1
:hidden:

x/template
1/template

The RFC process is defined in `RFC-x <x/index.html>`_
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 <x/template.html>`_ is available for the
creation of new RFCs. The diagram below shows the

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
stages that an RFC progresses through.

.. image:: x/diagram.png
.. image:: 1/diagram.png
:alt: Process Diagram
Loading