docs: update issue templates to include required sections

and note not to remove template sections to keep this consistent with edgex-go Signed-off-by: jpwhitemn <[email protected]>
cloudxxx8 · Dec 14, 2021 · 3199f92 · 3199f92
1 parent 940e3e0
commit 3199f92
Show file tree

Hide file tree

Showing 3 changed files with 18 additions and 12 deletions.
diff --git a/.github/ISSUE_TEMPLATE/1-bug-report.md b/.github/ISSUE_TEMPLATE/1-bug-report.md
@@ -10,12 +10,15 @@ Hello there! 😄
 To expedite issue processing please search open and closed issues before submitting a new one.
 Existing issues often contain information about workarounds, resolution, or progress updates.
 
-🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
+Please do not remove sections of this template when submitting your issue.  If the section is not relevant to your issue, leave the section but enter "n/a" for not applicable.
+
+Note some sections are marked "REQUIRED" and must be provided.  Never mark required sections "n/a".
 
+🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
 
 # 🐞 Bug Report
 
-### Description and Minimal Reproduction
+### Description and Minimal Reproduction [**REQUIRED**]
 
 
 ## 🔥 Exception or Error
@@ -25,10 +28,10 @@ Existing issues often contain information about workarounds, resolution, or prog
 
 </code></pre>
 
-
 ## 🌍  Your Environment
-**EdgeX Version:**
+**Deployment Environment:**
 
+**EdgeX Version [**REQUIRED**]:**
 
 **Anything else relevant?**
 
diff --git a/.github/ISSUE_TEMPLATE/2-feature-request.md b/.github/ISSUE_TEMPLATE/2-feature-request.md
@@ -10,15 +10,17 @@ Oh hi there! 😄
 To expedite issue processing please search open and closed issues before submitting a new one.
 Existing issues often contain information about workarounds, resolution, or progress updates.
 
-🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
+Please do not remove sections of this template when submitting your issue.  If the section is not relevant to your issue, leave the section but enter "n/a" for not applicable.
+
+Note some sections are marked "REQUIRED" and must be provided.  Never mark required sections "n/a".
 
+🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
 
 # 🚀 Feature Request
 
-### Description
+### Description [**REQUIRED**]
 <!-- ✍️--> A clear and concise description of the problem or missing capability...
 
-
 ### Describe the solution you'd like
 <!-- ✍️--> If you have a solution in mind, please describe it.
 

diff --git a/.github/ISSUE_TEMPLATE/3-docs-bug.md b/.github/ISSUE_TEMPLATE/3-docs-bug.md
@@ -10,39 +10,40 @@ Oh hi there! 😄
 To expedite issue processing please search open and closed issues before submitting a new one.
 Existing issues often contain information about workarounds, resolution, or progress updates.
 
+Please do not remove sections of this template when submitting your issue.  If the section is not relevant to your issue, leave the section but enter "n/a" for not applicable.
+
+Note some sections are marked "REQUIRED" and must be provided.  Never mark required sections "n/a".
+
 🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅🔅-->
 
 # 📚 Docs or Wiki Bug Report
 
-### Description
+### Description [**REQUIRED**]
 
 <!-- ✍️edit:--> A clear and concise description of the problem...
 
 
 ## 🔬 Minimal Reproduction
 
-### What's the affected URL?**
+### What's the affected URL? [**REQUIRED**]
 <!-- ✍️edit:--> https://docs.edgexfoundry.org/...
 
 
 ### Expected vs Actual Behavior**
 <!-- If applicable please describe the difference between the expected and actual behavior after following the steps to reproduce. -->
 <!-- ✍️edit:-->
 
-
 ## 📷Screenshot 
 <!-- Often a screenshot can help to capture the issue better than a long description. -->
 <!-- ✍️upload a screenshot:-->
 
-
 ## 🔥 Exception or Error
 <pre><code>
 <!-- If the issue is accompanied by an exception or an error, please share it below: -->
 <!-- ✍️-->
 
 </code></pre>
 
-
 ## 🌍  Your Environment
 <!-- How are you viewing the docs? What browser? What version? : -->
 <!-- ✍️-->