From 0e23fa04b4f34f39dccda2dbc5d343f41cd83000 Mon Sep 17 00:00:00 2001
From: Randalphwa <38287198+Randalphwa@users.noreply.github.com>
Date: Tue, 27 Sep 2022 11:58:11 -0700
Subject: [PATCH] Refactor issue templates using HTML comments

The main purpose is to place explanations in HTML comments which will
be automatically stripped out when the issue is submitted to GitHub.

Closes #22825, #22827.
---
 .github/ISSUE_TEMPLATE/bug_report.md    | 61 +++++++++++++++++--------
 .github/ISSUE_TEMPLATE/build_problem.md | 20 +++++---
 .github/ISSUE_TEMPLATE/enhancement.md   |  7 ++-
 3 files changed, 60 insertions(+), 28 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index c20c2cb0e5..cb4eb30a8d 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -6,41 +6,62 @@ labels: ''
 assignees: ''
 
 ---
+<!--
 
 IMPORTANT NOTE
 --------------
 
-This is a _template_, please **REMOVE** all the placeholders after filling in all the applicable sections as indicated, including this note.
+Please note that this entry field uses [Markdown][1], which means that you
+need to escape any code snippets pasted here using fenced code blocks,
+i.e. by putting ``` before and after it. Also escape, using
+backslash, i.e. `\<` any angle brackets to prevent them from being
+interpreted as HTML tags.
 
-Please also note that this entry field uses [Markdown][1], which means that you need to escape any code snippets pasted here using the fenced code blocks, i.e. by putting <tt>```</tt> before and after it. Also escape, using backslash, i.e. `\<` any angle brackets to prevent them from being interpreted as HTML tags.
+Use the Preview tab to review your issue before submitting it to verify that
+your formatting is correct.
 
 [1]: https://docs.github.com/github/writing-on-github/getting-started-with-writing-and-formatting-on-github/basic-writing-and-formatting-syntax
 
 ---
 
-**Describe the bug**
+Describe the bug:
 A clear and concise description of what the bug is.
 
-**Expected vs observed behaviour**
-Please describe what you expected to happen and what actually happens. Make sure to explain what exactly is the problem, just attaching a screenshot is not always sufficient. When in doubt, please provide more details rather than too few.
+Expected vs observed behaviour:
+Please describe what you expected to happen and what actually happens. Make
+sure to explain what exactly is the problem, just attaching a screenshot is
+not always sufficient. When in doubt, please provide more details rather
+than too few.
 
-**Patch or snippet allowing to reproduce the problem**
-Please attach the smallest possible patch allowing to reproduce the problem in a sample. If there is absolutely no appropriate sample, please attach a minimal self-contained example in a single file.
+Patch or snippet allowing to reproduce the problem:
+Please attach the smallest possible patch allowing to reproduce the problem
+in a sample. If there is absolutely no appropriate sample, please attach a
+minimal self-contained example in a single file.
 
-Skip this step if the problem can be reproduced in one of the samples without any changes.
+Skip this step if the problem can be reproduced in one of the samples
+without any changes.
+
+To Reproduce:
+Steps to reproduce the behaviour, please make them as detailed as possible.
+For example:
 
-**To Reproduce**
-Steps to reproduce the behaviour, please make them as detailed as possible, e.g.
 1. Go to '...'
-2. Click on '....'
-3. Scroll down to '....'
+2. Click on '...'
+3. Scroll down to '...'
 4. See error
+-->
 
-**Platform and version information**
- - wxWidgets version you use: [e.g. 3.1.6]
- - wxWidgets port you use: [e.g. wxMSW, wxGTK, wxOSX]
- - OS and its version: [e.g. Windows 10.0.19042.867, Ubuntu 22.10, macOS 15]
- - For wxGTK only (**remove** this if not using wxGTK)
-   + GTK version: [e.g. 3.24.5]
-   + Which GDK backend is used: [X11 or Wayland]
-   + If relevant, i.e. for appearance-related problems: [current theme]
+### Description
+<!-- Describe the bug here -->
+
+
+### Platform and version information
+
+- wxWidgets version <!-- [e.g. 3.2.1] --> you use:
+- wxWidgets port <!-- [e.g. wxMSW, wxGTK, wxOSX] --> you use:
+- OS <!-- [e.g. Windows 10, Ubuntu 22.10, macOS 15] --> and its version:
+
+<!-- For wxGTK only (**remove** this section if not using wxGTK) -->
++ GTK version: <!-- [e.g. 3.24.5] -->
++ Which GDK <!-- [X11 or Wayland] --> backend is used:
++ Current theme: <!-- (If relevant, i.e. for appearance-related problems) -->
diff --git a/.github/ISSUE_TEMPLATE/build_problem.md b/.github/ISSUE_TEMPLATE/build_problem.md
index 08043932fb..32ece1b26a 100644
--- a/.github/ISSUE_TEMPLATE/build_problem.md
+++ b/.github/ISSUE_TEMPLATE/build_problem.md
@@ -6,9 +6,9 @@ labels: 'build'
 assignees: ''
 
 ---
+<!--
 
-**Describe the problem**
-Describe how exactly do you build wxWidgets, including the full `configure`
+Please describe exactly how you build wxWidgets, including the full `configure`
 command line and/or `make` command line if relevant.
 
 Please attach the full build log, but feel free to quote the relevant parts of
@@ -16,9 +16,15 @@ it here.
 
 When using `configure`, please also attach `config.log` file.
 
+-->
 
-**Platform and version information**
- - wxWidgets version you use: [e.g. 3.1.6]
- - wxWidgets port you use: [e.g. wxMSW, wxGTK, wxOSX]
- - OS and its version: [e.g. Windows 10.0.19042.867, Ubuntu 22.10, macOS 15]
- - Compiler being used: [e.g. MSVS 2022, gcc 12.1]
+### Description
+<!-- Describe the problem here -->
+
+
+### Platform and version information
+
+- wxWidgets version <!-- [e.g. 3.2.1] --> you are building:
+- wxWidgets port <!-- [e.g. wxMSW, wxGTK, wxOSX] --> you are building:
+- OS <!-- [e.g. Windows 10, Ubuntu 22.10, macOS 15] --> and its version:
+- Compiler <!-- [e.g. MSVS 2022, gcc 12.1] --> being used:
diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md
index 2a37fa3a77..81390fd78a 100644
--- a/.github/ISSUE_TEMPLATE/enhancement.md
+++ b/.github/ISSUE_TEMPLATE/enhancement.md
@@ -7,9 +7,14 @@ assignees: ''
 
 ---
 
-**Describe the proposed addition**
+<!--
 
 Implementation ideas and helpful links, e.g. to platform-specific API that can
 be used, are welcome.
 
 Please mention if you propose to submit pull requests implementing this.
+
+-->
+
+### Description
+<!-- Describe the proposed addition here -->