From 412608863eea724771fdd8c68e10f5540a58a8d7 Mon Sep 17 00:00:00 2001
From: David Yu <dyu@hashicorp.com>
Date: Fri, 17 Feb 2023 15:01:31 -0800
Subject: [PATCH] ISSUE_TEMPLATE: formatting for comments (#16325)

* Update all templates.
---
 .github/ISSUE_TEMPLATE/bug_report.md      | 27 +++----------
 .github/ISSUE_TEMPLATE/feature_request.md | 18 ++-------
 .github/ISSUE_TEMPLATE/ui_issues.md       | 48 ++++++-----------------
 .github/pull_request_template.md          |  6 +--
 4 files changed, 20 insertions(+), 79 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 8a7e26fd22..678431cae3 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -4,25 +4,18 @@ about: You're experiencing an issue with Consul that is different than the docum
 
 ---
 
-<!-- 
-
-When filing a bug, please include the following headings if possible. Any example text in this template can be deleted.
-
+<!-- When filing a bug, please include the following headings if possible. Any example text in this template can be deleted.
 -->
 
 #### Overview of the Issue
 
-<!-- 
-
-Please provide a paragraph or two about the issue you're experiencing.
-
--->
+<!-- Please provide a paragraph or two about the issue you're experiencing. -->
 
 ---
 
 #### Reproduction Steps
 
-<!-- Please provide steps to reproduce the bug, without any details it would 
+<!-- Please provide steps to reproduce the bug, without any details it would be hard to troubleshoot: 
 
 Steps to reproduce this issue, eg:
 
@@ -65,18 +58,8 @@ Server agent HCL config
 
 ### Operating system and Environment details
 
-<!-- 
-
-OS, Architecture, and any other information you can provide about the environment.
-
--->
+<!--  OS, Architecture, and any other information you can provide about the environment. -->
 
 ### Log Fragments
 
-<!-- 
-
-Please provide log file excerpts using the finest log level possible (i.e. DEBUG, TRACE). 
-
--->
-
-Include appropriate Client or Server log fragments. If the log is longer than a few dozen lines, please include the URL to the [gist](https://gist.github.com/) of the log instead of posting it in the issue. Use `-log-level=TRACE` on the client and server to capture the maximum log detail.
+<!-- Include appropriate Client or Server log fragments. If the log is longer than a few dozen lines, please include the URL to the [gist](https://gist.github.com/) of the log instead of posting it in the issue. Use `-log-level=TRACE` on the client and server to capture the maximum log detail. -->
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index b3cd70e8cd..14017a9ae9 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -4,24 +4,12 @@ about: If you have something you think Consul could improve or add support for.
 
 ---
 
-<!---
-
-Please search the existing issues for relevant feature requests, and use the reaction feature (https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to add upvotes to pre-existing requests.
-
---->
+<!--- Please search the existing issues for relevant feature requests, and use the reaction feature (https://blog.github.com/2016-03-10-add-reactions-to-pull-requests-issues-and-comments/) to add upvotes to pre-existing requests. --->
 
 #### Feature Description
 
-<!---
-
-A written overview of the feature.
-
---->
+<!--- Please provide a written overview of the feature and why this feature solves challenges that you are facing today. --->
 
 #### Use Case(s)
 
-<!---
-
-Please describe the use case for this feature (i.e. Service Mesh, Service Discovery, KV, API Gateway). 
-
--->
+<!--- Please describe the use case for this feature (i.e. Service Mesh, Service Discovery, KV, API Gateway) and also deployment environments you are looking to see this addressed in (K8s, VMs, Nomad, ECS, Lambda). -->
diff --git a/.github/ISSUE_TEMPLATE/ui_issues.md b/.github/ISSUE_TEMPLATE/ui_issues.md
index 3a3ca0ed17..3f1dc3f037 100644
--- a/.github/ISSUE_TEMPLATE/ui_issues.md
+++ b/.github/ISSUE_TEMPLATE/ui_issues.md
@@ -4,26 +4,16 @@ about: You have usage feedback for the browser based UI
 
 ---
 
-<!---
-
-When filing a bug, please include the following headings if possible. Any example text in this template can be deleted.
-
---->
+<!--- When filing a bug, please include the following headings if possible. Any example text in this template can be deleted. --->
 
 ### Overview of the Issue
 
-<!---
-
-Please provide a paragraph or two about the issue you're experiencing / suggestion for
-improvement.
-
---->
+<!--- Please provide a paragraph or two about the issue you're experiencing / suggestion for
+improvement. --->
 
 ### Reproduction Steps
 
-<!---
-
-Steps to reproduce this issue/view the area for improvement, eg:
+<!--- Steps to reproduce this issue/view the area for improvement, eg:
 
 1. Visit the UI page at `/ui/services`
 1. Click .... then click...etc.
@@ -33,39 +23,23 @@ Steps to reproduce this issue/view the area for improvement, eg:
 
 ### Describe the solution you'd like
 
-<!---
-
-If this is an improvement rather than a bug, a clear and concise description
+<!--- If this is an improvement rather than a bug, a clear and concise description
 of what you want to happen. How have you seen this problem solved in other
-UIs?
-
---->
+UIs? --->
 
 ### Consul Version
 
-<!---
-
-This can be found either in the footer of the UI (Consul versions pre 1.10) or
-at the top of the help menu that is in the top right side of the UI.
-
---->
+<!--- This can be found either in the footer of the UI (Consul versions pre 1.10) or
+at the top of the help menu that is in the top right side of the UI. --->
 
 ### Browser and Operating system details
 
-<!---
-
-Browser, Browser Version, OS, and any other information you can provide about the environment that may be relevant.
-
---->
+<!--- Browser, Browser Version, OS, and any other information you can provide about the environment that may be relevant. --->
 
 ### Screengrabs / Web Inspector logs
 
-<!---
-
-If you think it's worthwhile, include appropriate screengrabs showing the
+<!--- If you think it's worthwhile, include appropriate screengrabs showing the
 error/area for improvement. Try to include the URL bar of the browser so we
 can see the current URL where the error manifests. Please be careful to
 obfuscate any sensitive information either in the URL or in the browser page
-itself.
-
---->
+itself. --->
diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md
index 7f1e645aa3..ed7531f38e 100644
--- a/.github/pull_request_template.md
+++ b/.github/pull_request_template.md
@@ -1,10 +1,6 @@
 ### Description
 
-<!--
-
-Please describe why you're making this change, in plain English.
-
--->
+<!-- Please describe why you're making this change, in plain English. -->
 
 ### Testing & Reproduction steps