From 05d4d04a338e6f5d38ed11dfedea6d226ce16a1a Mon Sep 17 00:00:00 2001
From: Yuxuan Shui <yshuiv7@gmail.com>
Date: Sun, 18 Aug 2019 01:34:18 +0100
Subject: [PATCH] issue template: use proper html comment

This way the report doesn't have to remove the comments in the template.

Signed-off-by: Yuxuan Shui <yshuiv7@gmail.com>
---
 .github/issue_template.md | 38 ++++++++++++++++++++++----------------
 1 file changed, 22 insertions(+), 16 deletions(-)

diff --git a/.github/issue_template.md b/.github/issue_template.md
index 652e4ad7..40af2e86 100644
--- a/.github/issue_template.md
+++ b/.github/issue_template.md
@@ -1,20 +1,22 @@
-// The template below is for reporting bugs. For feature requests and others, feel free to delete irrelevant entries.
+<!-- The template below is for reporting bugs. For feature requests and others, feel free to delete irrelevant entries. -->
 
 ### Platform
-// Example: Ubuntu Desktop 17.04 amd64
+<!-- Example: Ubuntu Desktop 17.04 amd64 -->
 
 ### GPU, drivers, and screen setup
-// Example: NVidia GTX 670, nvidia-drivers 381.09, two monitors configured side-by-side with xrandr
-// Please include the version of the video drivers (xf86-video-*) and mesa.
-// Please also paste the output of `glxinfo -B` here.
+<!--
+    Example: NVidia GTX 670, nvidia-drivers 381.09, two monitors configured side-by-side with xrandr
+    Please include the version of the video drivers (xf86-video-*) and mesa.
+    Please also paste the output of `glxinfo -B` here.
+ -->
 
 ### Environment
-// Tell us something about the desktop environment you are using, for example: i3-gaps, Gnome Shell, etc.
+<!-- Tell us something about the desktop environment you are using, for example: i3-gaps, Gnome Shell, etc. -->
 
 ### Compton version
-// Put the output of `compton --version` here.
-// If you are running compton v4 or later, please also include the output of `compton --diagnostics`
-// Example: v1
+<!-- Put the output of `compton --version` here. -->
+<!-- If you are running compton v4 or later, please also include the output of `compton --diagnostics` -->
+<!-- Example: v1 -->
 
 ### Compton configuration:
 ```
@@ -22,8 +24,10 @@
 ```
 
 ### Steps of reproduction
-// If you can reliably reproduce this bug, please describe the quickest way to do so
-// This information will greatly help us diagnosing and fixing the issue.
+<!--
+    If you can reliably reproduce this bug, please describe the quickest way to do so
+    This information will greatly help us diagnosing and fixing the issue.
+ -->
 
 1.
 2.
@@ -33,11 +37,13 @@
 ### Current Behavior
 
 ### Stack trace
-// If compton crashes, please make sure your compton is built with debug info, and provide a stack trace of compton when it crashed.
-// Note, when compton crashes in a debugger, your screen might look frozen. But gdb will still handle your input if it is focused.
-// Usually you can use 'bt' and press enter to get the stack trace, then 'q', enter, 'y', enter to quit gdb.
+<!--
+    If compton crashes, please make sure your compton is built with debug info, and provide a stack trace of compton when it crashed.
+    Note, when compton crashes in a debugger, your screen might look frozen. But gdb will likely still handle your input if it is focused.
+    Often you can use 'bt' and press enter to get the stack trace, then 'q', enter, 'y', enter to quit gdb.
+ -->
 
-// Or, you can enable core dump, and upload the core file and the compton executable here.
+<!-- Or, you can enable core dump, and upload the core file and the compton executable here. -->
 
 ### Other details
-// If your problem is visual, you are encouraged to record a short video when the problem occurs and link to it here.
+<!-- If your problem is visual, you are encouraged to record a short video when the problem occurs and link to it here. -->