diff --git a/design-doc-template.adoc b/design-doc-template.adoc index b643d3a3..12a488a7 100644 --- a/design-doc-template.adoc +++ b/design-doc-template.adoc @@ -42,7 +42,7 @@ categories: === QE Contacts === Testing By -// Put an x in the relevant field to indicate if testing will be done by Engineering or QE. +// Put an x in the relevant field to indicate if testing will be done by Engineering or QE. // Discuss with QE during the Kickoff state to decide this * [ ] Engineering @@ -97,9 +97,9 @@ categories: //== Implementation Plan //// -Delete if not needed. The intent is if you have a complex feature which can -not be delivered all in one go to suggest the strategy. If your feature falls -into this category, please mention the Release Coordinators on the pull +Delete if not needed. The intent is if you have a complex feature which can +not be delivered all in one go to suggest the strategy. If your feature falls +into this category, please mention the Release Coordinators on the pull request so they are aware. //// @@ -129,10 +129,10 @@ Generally a feature should have documentation as part of the PR to wildfly main, == Release Note Content //// Draft verbiage for up to a few sentences on the feature for inclusion in the -Release Note blog article for the release that first includes this feature. +Release Note blog article for the release that first includes this feature. Example article: http://wildfly.org/news/2018/08/30/WildFly14-Final-Released/. This content will be edited, so there is no need to make it perfect or discuss what release it appears in. "See Overview" is acceptable if the overview is -suitable. For simple features best covered as an item in a bullet-point list -of features containing a few words on each, use "Bullet point: " +suitable. For simple features best covered as an item in a bullet-point list +of features containing a few words on each, use "Bullet point: " ////