Skip to content

Commit 62a6b2b

Browse files
authored
Improving the RFC process
See #50 (comment) for more context.
1 parent 70a08a6 commit 62a6b2b

File tree

1 file changed

+12
-4
lines changed

1 file changed

+12
-4
lines changed

CONTRIBUTING.md

+12-4
Original file line numberDiff line numberDiff line change
@@ -101,8 +101,16 @@ $ cargo fmt --all
101101
Designing APIs for Gloo, its utility crates, and interfaces between them takes a
102102
lot of care. The design space is large, and there is a lot of prior art to
103103
consider. When coming to consensus on a design, we use a simplified, informal
104-
version of [our RFC process][rfcs], where we have design discussions inside the
105-
Gloo issues tracker.
104+
version of [our RFC process][rfcs].
105+
106+
When making a proposal, you must create a new pull request on this repo.
107+
The pull request's title must start with `[RFC]`.
108+
109+
The pull request must add a new file into the `rfcs` folder. This file
110+
contains all the information for the proposal.
111+
112+
It is expected that other people will write reviews pointing out various
113+
flaws, which should be fixed by adding new commits to the pull request.
106114

107115
> Note: when fixing a bug in a semver-compatible way that doesn't add any new
108116
> API surface (i.e. changes are purely internal) we can skip the design proposal
@@ -126,8 +134,8 @@ of types and function/method signatures. We should have a clear idea of the
126134
layers of APIs we are exposing, and how they are built upon one another.
127135

128136
Note that exploratory implementations outside of Gloo are encouraged during this
129-
period to get a sense for the API's usage, but you shouldn't send a pull request
130-
until the design has been accepted.
137+
period to get a sense for the API's usage, but you shouldn't send an implementation
138+
pull request until the design has been accepted.
131139

132140
Before the design is accepted, at least two team members must have stated that
133141
they are in favor of accepting the design in the issue thread.

0 commit comments

Comments
 (0)