15308555518/ website
1
0
Fork 0
mirror of https://github.com/kubesphere/website.git synced 2025-12-26 00:12:48 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Update proposal template

This commit is contained in:
Ray Zhou 2020-03-17 16:40:21 +08:00
parent 293d910ef4
commit 8b5f4103be
1 changed files with 16 additions and 15 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
contribution/design-proposal-template.md
View File

@ -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>
< enumerated list of use cases for this feature >
<in depth description of user experience>
< 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.>
< 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>
< draw a diagram to describe your idea, it could be an architecture diagram >
### API
<enumerated list of APIs and designs for this feature>
< 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>
< short description of alternative solutions to be considered, you can attach some references to help us understand the alternatives >