Skip to content

Latest commit

 

History

History
42 lines (22 loc) · 1.15 KB

design-proposal-template.md

File metadata and controls

42 lines (22 loc) · 1.15 KB

Proposal Template for New Feature

There are some good examples for new proposals:

Here is a proposal template for new feature.

Background

< 4-8 sentences about why this is needed >

Solution

< 4-8 sentences of the proposed solution >

User Experience

Use Cases

< enumerated list of use cases for this feature >

< in depth description of user experience >

< include full examples and references >

Implementation

< in depth description of how the feature will be implemented. In some cases this may be very simple. >

High Level Overview

< draw a diagram to describe your idea, it could be an architecture diagram >

API

< enumerated list of APIs and designs for this feature >

Alternatives considered

< short description of alternative solutions to be considered, you can attach some references to help us understand the alternatives >