@@ -38,16 +38,22 @@ In short, to get a major feature added to Gatsby, one usually first puts up a Di
38
38
- Copy the RFC template into your clipboard:
39
39
40
40
``` md
41
- # Summary
41
+ ## Summary
42
42
43
43
Brief explanation of the feature.
44
44
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
46
52
47
53
If the proposal involves a new or changed API, include a basic code example.
48
54
Omit this section if it's not applicable.
49
55
50
- # Motivation
56
+ ## Motivation
51
57
52
58
Why are we doing this? What use cases does it support? What is the expected
53
59
outcome?
@@ -57,15 +63,15 @@ In short, to get a major feature added to Gatsby, one usually first puts up a Di
57
63
enumerate the constraints you are trying to solve without coupling them too
58
64
closely to the solution you have in mind.
59
65
60
- # Detailed design
66
+ ## Detailed design
61
67
62
68
This is the bulk of the RFC. Explain the design in enough detail for somebody
63
69
familiar with Gatsby to understand, and for somebody familiar with the
64
70
implementation to implement. This should get into specifics and corner-cases,
65
71
and include examples of how the feature is used. Any new terminology should be
66
72
defined here.
67
73
68
- # Drawbacks
74
+ ## Drawbacks
69
75
70
76
Why should we _not_ do this? Please consider:
71
77
@@ -77,17 +83,17 @@ In short, to get a major feature added to Gatsby, one usually first puts up a Di
77
83
78
84
There are tradeoffs to choosing any path. Attempt to identify them here.
79
85
80
- # Alternatives
86
+ ## Alternatives
81
87
82
88
What other designs have been considered? What is the impact of not doing this?
83
89
84
- # Adoption strategy
90
+ ## Adoption strategy
85
91
86
92
If we implement this proposal, how will existing Gatsby developers adopt it? Is
87
93
this a breaking change? Can we write a codemod? Should we coordinate with
88
94
other projects or libraries?
89
95
90
- # How we teach this
96
+ ## How we teach this
91
97
92
98
What names and terminology work best for these concepts and why? How is this
93
99
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
98
104
99
105
How should this feature be taught to existing Gatsby developers?
100
106
101
- # Unresolved questions
107
+ ## Unresolved questions
102
108
103
109
Optional, but suggested for first drafts. What parts of the design are still
104
110
TBD?
0 commit comments