-
Notifications
You must be signed in to change notification settings - Fork 4.3k
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
Documentation: Add RFCs process document #15687
Closed
Closed
Changes from 1 commit
Commits
Show all changes
6 commits
Select commit
Hold shift + click to select a range
dcdb031
Documentation: Add RFCs README document
aduth dc71c8c
Documentation: Add RFC process informed references
aduth e2fd7bc
Documentation: Add link to RFC process in developer contributions doc…
aduth 33fb091
Documentation: Add section "Why have an RFC process?"
aduth 59b2f10
Documentation: Clarify example RFCs as Gutenberg-specific
aduth 51b844d
Documentation: Mention core component maintainers as RFC discussion p…
aduth File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change | ||||
---|---|---|---|---|---|---|
@@ -0,0 +1,55 @@ | ||||||
# Requests for Comments (RFCs) | ||||||
|
||||||
To maintain an effective and transparent process for resolving complex technical problems, this project has implemented a Request for Comments (RFC) workflow. | ||||||
|
||||||
For more information, refer to the blog post: | ||||||
|
||||||
https://make.wordpress.org/core/2019/04/01/the-block-registration-rfc-and-the-gutenberg-rfc-process/ | ||||||
|
||||||
## What types of features or problems should be submitted as RFCs? | ||||||
|
||||||
While an issue can be sufficient to describe small feature requests, an RFC should be proposed for all features with impact across many areas of the code base, new patterns for extensibility APIs, and technical problems that are hard to solve without making compromises. | ||||||
|
||||||
## The RFC workflow | ||||||
|
||||||
The flow to propose a new RFC is the following: | ||||||
|
||||||
- Create an RFC document for your proposal in Markdown format. | ||||||
- Submit a pull request to the Gutenberg repository with the Markdown file included in the `docs/rfc` folder ([see examples](/docs/rfcs/)). | ||||||
- Discussion and feedback should take place in the pull request amongst the original author, Gutenberg Core team members, focus leads, and project contributors. | ||||||
- As a result of discussion in the pull request and at least one [weekly editor meeting](https://make.wordpress.org/meetings/), the RFC will be accepted (merged) or rejected (closed). | ||||||
|
||||||
A merged RFC should serve as a sufficient baseline for an initial implementation, and as the de-facto documentation for the feature. | ||||||
|
||||||
### RFC status | ||||||
|
||||||
An RFC may be merged as a working document. The status of a document should be noted as a [YAML front matter (metadata)](https://github.blog/2013-09-27-viewing-yaml-metadata-in-your-documents/) in the first lines of the file, as one of the following: | ||||||
|
||||||
#### `status: Draft` | ||||||
|
||||||
A "Draft" document is one which has been merged in a state sufficient for initial implementations, but which is expected to need future iterations to refine details or revise specifics which would only become apparent in the course of said implementations. The purpose of allowing for draft documents is to allow for a steady momentum of a feature proposal and to embrace quality via experimentation. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Tighten up a little, for example "refine details" and "revise specifics" are saying the same thing
Suggested change
|
||||||
|
||||||
Any document with a "Draft" status should be added as a column to the [Request for Comments (RFC) project](https://github.com/WordPress/gutenberg/projects/26) to serve as a reference for those interested to follow along with its progress. | ||||||
|
||||||
A "Draft" document should always be kept in sync with the current direction of implementations using it as a base. Proposed changes to the RFC document should be assigned to the Project column. | ||||||
|
||||||
#### `status: Standard` | ||||||
|
||||||
Once an RFC document is considered to be finalized, its status should be migrated to "Standard". | ||||||
|
||||||
A document is final once its feature implementation is complete, and upon approval by focus leads. | ||||||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more.
Suggested change
|
||||||
|
||||||
## What makes a good RFC document? | ||||||
|
||||||
A good RFC document can be broken into the following sections: | ||||||
|
||||||
- Description of the problems solved by the RFC | ||||||
- Current status and previous attempts | ||||||
- Solution Proposal | ||||||
- Unsolved Problems | ||||||
|
||||||
For reference, [view current RFCs](/docs/rfcs/). | ||||||
|
||||||
## Who can submit an RFC? | ||||||
|
||||||
Anyone can submit an RFC. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lead with what we are defining, not the why