Skip to content

Latest commit

 

History

History
43 lines (30 loc) · 1.05 KB

proposal-template.md

File metadata and controls

43 lines (30 loc) · 1.05 KB

This template is simply a guide. When making proposals, feel free to add and remove portions of this outline to best fit your specific case. There is no expectation that people strictly stick to this outline, but it is a good place to start.

Overview

(Provide a brief overview of the topic)

Motivation

(Why this enhancement is important)

Goals

(The desired outcome)

Non Goals

(limitations to the scope of the design)

Definition of Users

(who is this feature set intended for)

User Stories

(list of user stories this design aims to solve)

Repos

(list of repose this design impacts)

Design

(This should be brief and concise. We want just enough to get the point across)

API Examples

(tangible API examples used for discussion)

Scalability

(overview of how the design scales)

Update/Rollback Compatibility

(does this impact update compatibility and how)

Functional Testing Approach

(an overview on the approaches used to functional test this design)

Implementation Phases

(How/if this design will get broken up into multiple phases)