-
Notifications
You must be signed in to change notification settings - Fork 218
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
create design_proposal.md #2523
Changes from all commits
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,46 @@ | ||
--- | ||
name: 🤔 Design proposal | ||
about: Collaborate on a design for a feature/fix or other change | ||
labels: design-proposal | ||
--- | ||
|
||
<!-- | ||
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. | ||
--> | ||
|
||
## Summary | ||
|
||
1-2 sentences. Say what this is about. | ||
|
||
## Motivation and goals | ||
|
||
1-2 paragraphs, or a bullet-pointed list. What existing pain points does this solve? What evidence shows it's valuable to solve this? | ||
|
||
## In scope | ||
|
||
A list of major scenarios, perhaps in priority order. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. What are "major scenarios"? Can we define this and/or provide an example? |
||
|
||
## Out of scope | ||
|
||
Scenarios you explicitly want to exclude. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Same comment as above.... is feature an appropriate descriptor here? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Great comments Josh!! Will fix in later iteration! |
||
|
||
## Risks / unknowns | ||
|
||
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. | ||
|
||
## Examples | ||
|
||
Give brief examples of possible developer experiences (e.g., code they would write). | ||
|
||
Don't be deeply concerned with how it would be implemented yet. Your examples could even be from other technology stacks. | ||
|
||
<!-- | ||
# Detailed design | ||
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: | ||
Detailed design | ||
Drawbacks | ||
Considered alternatives | ||
Open questions | ||
References | ||
If there's one clear design you have consensus on, you could do that directly in a PR. | ||
--> |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
nit: can we change goals to "success criteria" I've found this phrasing generally results in more specific and measurable goals/criteria