Skip to content

Commit 73cc168

Browse files
committed
Introduce demo section to enhancement template
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>
1 parent e4a8436 commit 73cc168

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

enhancements/template.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -137,6 +137,21 @@ challenging to test should be called out.
137137
All code is expected to have adequate tests (eventually with coverage
138138
expectations).
139139

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+
140155
### Graduation Criteria
141156

142157
**Note:** *Section not required until targeted at a release.*

0 commit comments

Comments
 (0)