diff --git a/.github/ISSUE_TEMPLATE/design_proposal.md b/.github/ISSUE_TEMPLATE/design_proposal.md new file mode 100644 index 000000000..fcbb0749b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/design_proposal.md @@ -0,0 +1,46 @@ +--- +name: 🤔 Design proposal +about: Collaborate on a design for a feature/fix or other change +labels: design-proposal +--- + + + +## 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. + +## Out of scope + +Scenarios you explicitly want to exclude. + +## 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. + + \ No newline at end of file