diff --git a/contribution/design-proposal-template.md b/contribution/design-proposal-template.md index b126cd478..6bfcba5fd 100644 --- a/contribution/design-proposal-template.md +++ b/contribution/design-proposal-template.md @@ -1,41 +1,42 @@ # Proposal Template for New Feature -> There are some good examples for new proposals: -> - [Proposal for OpenEBS Volume (jiva) Snapshots using extended kubernetes Snapshot APIs](https://github.com/openebs/openebs/blob/master/contribute/design/openebs-jiva-snapshot-design.md) ->- [Support extended-resource assignment to a Container](https://github.com/kubesphere/kubesphere/issues/1851) +There are some good examples for new proposals: -Here is a Proposal Template for New Feature +- [Proposal for OpenEBS Volume (jiva) Snapshots using Extended Kubernetes Snapshot APIs](https://github.com/openebs/openebs/blob/master/contribute/design/openebs-jiva-snapshot-design.md) +- [Support Extended-resource Assignment to a Container](https://github.com/kubesphere/kubesphere/issues/1851) + +Here is a proposal template for new feature. ## Background -<4-8 sentences about why this is needed> +< 4-8 sentences about why this is needed > -## Proposal +## Solution -<4-8 description of the proposed 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*> +< 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 +### 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 >