Skip to content

Commit 8f652f7

Browse files
committed
[docs] Add a proposal template
Signed-off-by: Nick Volynkin <[email protected]>
1 parent 33dad69 commit 8f652f7

1 file changed

Lines changed: 91 additions & 0 deletions

File tree

‎design-proposals/template.md‎

Lines changed: 91 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,91 @@
1+
# Cozystack Enhancement Proposal: Your short, descriptive title
2+
3+
## Overview
4+
5+
<!--
6+
Write a brief overview of the proposed enhancement (functionality).
7+
-->
8+
9+
## 1. Goal Setting
10+
11+
### Motivation
12+
13+
<!--
14+
Why this enhancement is important.
15+
-->
16+
17+
## Users and User Stories
18+
19+
<!--
20+
Who will benefit from this improvement and what are their key user scenarios
21+
In terms of Jobs To Be Done: what they do now and will stop doing or will do much easier/faster.
22+
-->
23+
24+
### Goals and Non-goals
25+
26+
<!--
27+
Definition of the desired outcome.
28+
Limitations to the scope of the feature.
29+
-->
30+
31+
### Alternatives
32+
33+
<!--
34+
Outline any alternative designs that have been considered
35+
-->
36+
37+
### Trade-offs and Risks
38+
39+
<!--
40+
What are the limitations of this proposal?
41+
What risks can it cause?
42+
-->
43+
44+
## 2. Implementation
45+
46+
## Design and Architecture
47+
48+
<!--
49+
Give a brief and concise description of the solution.
50+
-->
51+
52+
## API Examples
53+
54+
<!--
55+
Examples of configuration, API calls, etc.
56+
-->
57+
58+
### Implementation Phases
59+
60+
<!--
61+
How/if this design will get broken up into multiple phases
62+
-->
63+
64+
## Update/Rollback Compatibility
65+
66+
<!--
67+
Does this feature require migrations in Cozystack services and/or user applications?
68+
Will they happen upon updating Cozystack or separately?
69+
-->
70+
71+
### Security
72+
73+
<!--
74+
Does the enhancement affect security?
75+
What will be done to mitigate the risks?
76+
-->
77+
78+
### Testing
79+
80+
<!--
81+
How will this be tested during the development phase?
82+
How will this
83+
-->
84+
85+
86+
---
87+
88+
<!--
89+
Based on the KubeVirt enhancement proposal process
90+
https://github.com/kubevirt/enhancements/blob/main/veps/NNNN-vep-template/vep.md
91+
-->

0 commit comments

Comments
 (0)