kubevela/design/TEMPLATE.md

607 B

NAME OF THE PROPOSAL

(Optional) Introduction

A short introduction to the proposal.

Background

Why we need the proposal.

(Optional) Goals & Non-Goals

The goals and non-goals of the proposal.

Proposal

The potential solutions and comparisons. Technique details should be placed here. Risks for break changes should be highlighted.

(Optional) Examples

The examples of how to use if the proposal is completed.

(Optional) Progress / Timeline / Milestones

Break the proposal implementation into atomic units and estimate the time cost and difficulties for the implementation.