github.com/oam-dev/kubevela@v1.9.11/design/TEMPLATE.md (about)

     1  # NAME OF THE PROPOSAL
     2  
     3  ### (Optional) Introduction
     4  
     5  A short introduction to the proposal.
     6  
     7  ### Background
     8  
     9  Why we need the proposal.
    10  
    11  ### (Optional) Goals & Non-Goals
    12  
    13  The goals and non-goals of the proposal.
    14  
    15  ### Proposal
    16  
    17  The potential solutions and comparisons. Technique details should be placed here. Risks for break changes should be highlighted.
    18  
    19  ### (Optional) Examples
    20  
    21  The examples of how to use if the proposal is completed.
    22  
    23  ### (Optional) Progress / Timeline / Milestones
    24  
    25  Break the proposal implementation into atomic units and estimate the time cost and difficulties for the implementation.