Skip to content

Commit 6efa864

Browse files
authored
Minor edits to CONTRIBUTING.md
1 parent 24ce9c0 commit 6efa864

File tree

1 file changed

+15
-14
lines changed

1 file changed

+15
-14
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -65,7 +65,7 @@ move forward. See editor Lee Byron talk about
6565
As GraphQL is implemented in over a dozen languages under the collaboration
6666
of hundreds of individuals, incorporating any change has a high cost.
6767
Accordingly, proposed changes must meet a very high bar of added value.
68-
The burden of proof of value is on the contributor to illustrate this value.
68+
The burden of proof is on the contributor to illustrate this value.
6969

7070
* **Enable new capabilities motivated by real use cases**
7171

@@ -116,17 +116,17 @@ entrance criteria and next steps detailed below. RFCs typically advance one
116116
stage at a time, however may advance multiple stages at a time. Stage
117117
advancements typically occur during
118118
[Working Group](https://github.com/graphql/graphql-wg) meetings, however may
119-
occur online.
119+
occur on GitHub.
120120

121121
All RFCs start as either a *strawman* or *proposal*.
122122

123123
## Stage 0: *Strawman*
124124

125125
A RFC at the *strawman* stage captures a described problem or
126126
partially-considered solutions. A *strawman* does not need to meet any entrance
127-
criteria. A *strawman's* goal is prove or disprove a problem and guide
128-
discussion towards rejection or a preferred solution. A *strawman* may be an
129-
issue or a pull request (though an illustrative pull request is preferrable).
127+
criteria. A *strawman's* goal is to prove or disprove a problem and guide
128+
discussion towards either rejection or a preferred solution. A *strawman* may
129+
be an issue or a pull request (though an illustrative pull request is preferrable).
130130

131131
*There is no entrance criteria for a Strawman*
132132

@@ -160,19 +160,20 @@ A *proposal* is subject to the same discussion as a *strawman*: ensuring that it
160160
is well aligned with the *guiding principles*, is a problem worth solving, and
161161
is the preferred solution to that problem. A *champion* is not expected to have
162162
confidence in every detail at this stage and should instead focus on identifying
163-
and resolving issues and edge-cases. To better understand the ramifications of a
164-
*proposal*, a *champion* is encouraged to implement it in a GraphQL library.
163+
and resolving issues and edge-cases. To better understand the technical
164+
ramifications of the *proposal*, a *champion* is encouraged to implement it in a
165+
GraphQL library.
165166

166167
Most *proposals* are expected to evolve or change and may be rejected. Therefore,
167168
it is unwise to rely on a *proposal* in a production GraphQL service. GraphQL
168169
libraries *may* implement *proposals*, though are encouraged to not enable the
169-
*proposal* feature without explicit opt-in.
170+
*proposed* feature without explicit opt-in.
170171

171172

172173
## Stage 2: *Draft*
173174

174175
An RFC at the *draft* stage is a fully formed solution. There is working group
175-
consensus that the problem identified is worth solving, and this particular
176+
consensus that the problem identified should be solved, and this particular
176177
solution is preferred. A *draft's* goal is to precisely and completely describe
177178
the solution and resolve any concerns through library implementations. A *draft*
178179
must be a pull request.
@@ -182,7 +183,7 @@ must be a pull request.
182183
* Consensus the solution is preferred (typically via Working Group)
183184
* Resolution of identified concerns and challenges
184185
* Precisely described with spec edits
185-
* Compliant implementation in GraphQL.js (via unmerged pull request)
186+
* Compliant implementation in GraphQL.js (might not be merged)
186187

187188
A *proposal* becomes a *draft* when the set of problems or drawbacks have been
188189
fully considered and accepted or resolved, and the solution is deemed
@@ -200,15 +201,15 @@ feature without explicit opt-in when possible.
200201
## Stage 3: *Accepted*
201202

202203
An RFC at the *accepted* stage is a completed solution. According to a spec
203-
editor it is ready to be merged as-is into the spec. The RFC is ready to be
204-
deployed in GraphQL libraries. An *accepted* RFC must be implemented
205-
in GraphQL.js.
204+
editor it is ready to be merged as-is into the spec document. The RFC is
205+
ready to be deployed in GraphQL libraries. An *accepted* RFC must be
206+
implemented in GraphQL.js.
206207

207208
*Entrace criteria*
208209

209210
* Consensus the solution is complete (via editor or working group)
210211
* Complete spec edits, including examples and prose
211-
* Compliant implementation in GraphQL.js (fully tested and merged)
212+
* Compliant implementation in GraphQL.js (fully tested and merged or ready to merge)
212213

213214
A *draft* is *accepted* when it has learned via implementation and tests that it
214215
appropriately handles all edge cases, that the spec edits do not only precisely

0 commit comments

Comments
 (0)