mirror of
https://github.com/harivansh-afk/rpi.git
synced 2026-04-22 06:00:33 +00:00
1.2 KiB
1.2 KiB
| task | type | repo | branch | sha | |||
|---|---|---|---|---|---|---|---|
| eng-xxxx-description | design-discussion |
|
|
|
Summary of change request
[summary of what the user wants to build based on their request and the ticket]
Current State
- [current state of codebase]
- ..
- ..
Desired End State
- [what will be true when this work is done]
- [user story, problems that will be solved, new things a user can do]
- ..
What we're not doing
- [things that are out of scope]
- ..
Patterns to follow
[title First pattern from research]
[summary of the pattern] - e.g. [path/to/file]
[succint code examples demonstrating the pattern]
[succint code examples demonstrating the pattern]
[title Second pattern from the research]
...
Design Questions
[title first question]
[the design question]
- Option A: ... [optional: short code snippet]
- Option B: ... [optional: short code snippet]
- ..
Reccomendation: [....]
[title second design question]
...
Resolved Design Questions
[title resolved question]
[option chosen] - [rationale] - [patternt to follow]
[ title second resolved question]
...