Skip to content

Commit ceff540

Browse files
authored
create design_proposal.md (#2523)
1 parent d6250f6 commit ceff540

File tree

1 file changed

+46
-0
lines changed

1 file changed

+46
-0
lines changed
Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: 🤔 Design proposal
3+
about: Collaborate on a design for a feature/fix or other change
4+
labels: design-proposal
5+
---
6+
7+
<!--
8+
This template is useful to build consensus about whether work should be done, and if so, the high-level shape of how it should be approached. Use this before fixating on a particular implementation.
9+
-->
10+
11+
## Summary
12+
13+
1-2 sentences. Say what this is about.
14+
15+
## Motivation and goals
16+
17+
1-2 paragraphs, or a bullet-pointed list. What existing pain points does this solve? What evidence shows it's valuable to solve this?
18+
19+
## In scope
20+
21+
A list of major scenarios, perhaps in priority order.
22+
23+
## Out of scope
24+
25+
Scenarios you explicitly want to exclude.
26+
27+
## Risks / unknowns
28+
29+
How might developers misinterpret/misuse this? How might implementing it restrict us from other enhancements in the future? Also list any perf/security/correctness concerns.
30+
31+
## Examples
32+
33+
Give brief examples of possible developer experiences (e.g., code they would write).
34+
35+
Don't be deeply concerned with how it would be implemented yet. Your examples could even be from other technology stacks.
36+
37+
<!--
38+
# Detailed design
39+
It's often best not to fill this out until you get basic consensus about the above. When you do, consider adding an implementation proposal with the following headings:
40+
Detailed design
41+
Drawbacks
42+
Considered alternatives
43+
Open questions
44+
References
45+
If there's one clear design you have consensus on, you could do that directly in a PR.
46+
-->

0 commit comments

Comments
 (0)