diff --git a/enhancements/template.md b/enhancements/template.md index 97f6f80b9..e5bfca9d1 100644 --- a/enhancements/template.md +++ b/enhancements/template.md @@ -12,7 +12,7 @@ creation-date: yyyy-mm-dd last-updated: yyyy-mm-dd status: provisional|implementable|implemented|deferred|rejected|withdrawn|replaced see-also: - - "/enhancements/this-other-neat-thing.md" + - "/enhancements/this-other-neat-thing.md" replaces: - "/enhancements/that-less-than-great-idea.md" superseded-by: @@ -61,9 +61,9 @@ around the enhancement process. ## Open Questions [optional] This is where to call out areas of the design that require closure before deciding -to implement the design. For instance, +to implement the design. For instance, > 1. This requires exposing previously private resources which contain sensitive - information. Can we do this? + information. Can we do this? ## Summary @@ -71,7 +71,7 @@ The `Summary` section is incredibly important for producing high quality user-focused documentation such as release notes or a development roadmap. It should be possible to collect this information before implementation begins in order to avoid requiring implementors to split their attention between writing -release notes and implementing the feature itself. +release notes and implementing the feature itself. A good summary is probably at least a paragraph in length. @@ -166,7 +166,7 @@ These are generalized examples to consider, in addition to the aforementioned - Sufficient test coverage - Gather feedback from users rather than just developers -##### Tech Preview -> GA +##### Tech Preview -> GA - More testing (upgrade, downgrade, scale) - Sufficient time for feedback