Skip to content

Commit 7156882

Browse files
authored
chore(docs): Update RFC template (#35682)
1 parent d383eab commit 7156882

File tree

1 file changed

+15
-9
lines changed

1 file changed

+15
-9
lines changed

docs/contributing/rfc-process.md

+15-9
Original file line numberDiff line numberDiff line change
@@ -38,16 +38,22 @@ In short, to get a major feature added to Gatsby, one usually first puts up a Di
3838
- Copy the RFC template into your clipboard:
3939

4040
```md
41-
# Summary
41+
## Summary
4242

4343
Brief explanation of the feature.
4444

45-
# Basic example
45+
## Try it out
46+
47+
Section with instructions on how to use the feature, e.g. with a canary.
48+
49+
<!-- When defining a canary for installation, tell users to use `--save-exact` (npm) or `--exact` (yarn) flag. -->
50+
51+
## Basic example
4652

4753
If the proposal involves a new or changed API, include a basic code example.
4854
Omit this section if it's not applicable.
4955

50-
# Motivation
56+
## Motivation
5157

5258
Why are we doing this? What use cases does it support? What is the expected
5359
outcome?
@@ -57,15 +63,15 @@ In short, to get a major feature added to Gatsby, one usually first puts up a Di
5763
enumerate the constraints you are trying to solve without coupling them too
5864
closely to the solution you have in mind.
5965

60-
# Detailed design
66+
## Detailed design
6167

6268
This is the bulk of the RFC. Explain the design in enough detail for somebody
6369
familiar with Gatsby to understand, and for somebody familiar with the
6470
implementation to implement. This should get into specifics and corner-cases,
6571
and include examples of how the feature is used. Any new terminology should be
6672
defined here.
6773

68-
# Drawbacks
74+
## Drawbacks
6975

7076
Why should we _not_ do this? Please consider:
7177

@@ -77,17 +83,17 @@ In short, to get a major feature added to Gatsby, one usually first puts up a Di
7783

7884
There are tradeoffs to choosing any path. Attempt to identify them here.
7985

80-
# Alternatives
86+
## Alternatives
8187

8288
What other designs have been considered? What is the impact of not doing this?
8389

84-
# Adoption strategy
90+
## Adoption strategy
8591

8692
If we implement this proposal, how will existing Gatsby developers adopt it? Is
8793
this a breaking change? Can we write a codemod? Should we coordinate with
8894
other projects or libraries?
8995

90-
# How we teach this
96+
## How we teach this
9197

9298
What names and terminology work best for these concepts and why? How is this
9399
idea best presented? As a continuation of existing Gatsby patterns?
@@ -98,7 +104,7 @@ In short, to get a major feature added to Gatsby, one usually first puts up a Di
98104

99105
How should this feature be taught to existing Gatsby developers?
100106

101-
# Unresolved questions
107+
## Unresolved questions
102108

103109
Optional, but suggested for first drafts. What parts of the design are still
104110
TBD?

0 commit comments

Comments
 (0)