Skip to content

Commit 02d2d47

Browse files
authored
docs(template): initial version
1 parent 5f1ad50 commit 02d2d47

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

template.md

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,23 @@
1+
# Feature name
2+
3+
> A short description of what the feature is. Try to keep it to a single-paragraph "elevator pitch" so the reader understands what problem this proposal is addressing.
4+
5+
## Motivation
6+
7+
> Describe the problems that this proposal seeks to address. If the problem is that some common pattern is currently hard to implement, show how one can currently get a similar effect and describe its drawbacks. If it's completely new functionality that cannot be emulated, motivate why this new functionality would help developers create better workflows. Include any links to Issues or Pull Requests where the need for this feature came up.
8+
9+
## Proposed solution
10+
11+
> Describe your solution to the problem. Provide examples and describe how they work. Show how your solution is better than current workarounds.
12+
13+
## Detailed design
14+
15+
> Describe the design of the solution in detail. The detail in this section should be sufficient for someone who is *not* one of the authors to be able to reasonably implement the feature.
16+
17+
## Backward compatibility
18+
19+
> Describe how this change affects compatibility with existing community packages. Will they break? Will they produce different behavior? If "yes" to either of these, is it possible to support the old behavior alongside the new behavior? Can scripts be written in a way that they work before and after this change?
20+
21+
## Alternatives considered
22+
23+
> Describe alternative approaches to addressing the same problem, and why you chose this approach instead.

0 commit comments

Comments
 (0)