You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
This commit introduces a "Prototype Demo" section to the enhancement
template. The goal of this section is to provide the submitter with
the opportunity to include a demo of a prototype that can be referenced
during design discussions.
Signed-off-by: Alexander Greene <greene.al1991@gmail.com>
Copy file name to clipboardExpand all lines: enhancements/template.md
+15Lines changed: 15 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -137,6 +137,21 @@ challenging to test should be called out.
137
137
All code is expected to have adequate tests (eventually with coverage
138
138
expectations).
139
139
140
+
### Prototype Demo [optional]
141
+
142
+
A demo showcasing a prototype of your design can be extremely useful to the
143
+
community when reviewing your proposal. There are many services that enable
144
+
you to record and share demos. Most OLM features can be showcased from the
145
+
command line, making [https://asciinema.org](https://asciinema.org) an
146
+
excellent option to [record](https://asciinema.org/docs/usage) and
147
+
[embed](https://asciinema.org/docs/embedding) your demo.
148
+
149
+
Be sure to include:
150
+
- An embedded recording of the prototype in action.
151
+
- A link to the repository hosting the changes that the prototype introduces.
152
+
153
+
An example of this section can be found [here](https://github.com/operator-framework/enhancements/blob/87e6ac32a0caac86fdfc733740892da612d00ee2/enhancements/fail-forward-upgrades.md#prototype-demo).
154
+
140
155
### Graduation Criteria
141
156
142
157
**Note:***Section not required until targeted at a release.*
0 commit comments