Title
| Field | Value |
|---|---|
| Status | Draft |
| Date | YYYY-MM-DD |
This section targets end users, operators, PM, SEs and anyone else that might need a quick explaination of your proposed change.
Why do we want this change and what problem are we trying to address?
A brief summary of the proposed change - the 10,000 ft view on what it will change once this change is implemented.
In this section of the document the target audience is the dev team. Upon reading this section each engineer should have a rather clear picture of what needs to be done in order to implement the described feature.
This section is freeform - you should describe your change is as much detail as possible. Please also ensure to include any context or background info here. For example, do we have existing components which can be reused or altered.
By reading this section, each team memeber should be able to know what exactly you're planning to change and how.
Highlight how the change may affect the rest of the product (new components, modifications in other areas), or other teams/products.
List any concerns, unknowns, and generally unresolved questions etc.
List any alternatives considered, and the reasons for choosing this option over them.
| Date | Comment |
|---|---|
| YYYY-MM-DD | Initial Draft |