Advise users to retain issue/PR templates

[mirror_zfs.git] / .github / ISSUE_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
index b93045731b7a028434eac7c12ea02d9358cbc2b9..e77ab39f35bda7850151b5c3f5dd4fa8dd3ae6b9 100644 (file)
--- a/.github/ISSUE_TEMPLATE.md
+++ b/.github/ISSUE_TEMPLATE.md
@@ -1,23 +1,30 @@
+<!-- Please fill out the following template, which will help other contributors address your issue. -->
+
 <!--
 Thank you for reporting an issue.
 
-This issue tracker is for bugs and issues only.
-If you need general support please use 
-our mailing list. https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists
+*IMPORTANT* - Please search our issue tracker *before* making a new issue.
+If you cannot find a similar issue, then create a new issue.
+https://github.com/zfsonlinux/zfs/issues 
+
+*IMPORTANT* - This issue tracker is for *bugs* and *issues* only.
+Please search the wiki and the mailing list archives before asking 
+questions on the mailing list.
+https://github.com/zfsonlinux/zfs/wiki/Mailing-Lists
 
 Please fill in as much of the template as possible.
 -->
 
 ### System information
-<!--  add version after "|" character -->
-Type                                | Version/Name
-  ---                                  |     --- 
-Distribution Name       | 
-Distribution Version    | 
-Linux Kernel                 | 
-Architecture                 | 
-ZFS Version                  | 
-SPL Version                  | 
+<!--  add version after "|" character -->
+Type | Version/Name
+ --- | --- 
+Distribution Name      | 
+Distribution Version   | 
+Linux Kernel   | 
+Architecture   | 
+ZFS Version    | 
+SPL Version    | 
 <!-- 
 Commands to find ZFS/SPL versions:
 modinfo zfs | grep -iw version
@@ -30,6 +37,10 @@ modinfo spl | grep -iw version
 
 ### Include any warning/errors/backtraces from the system logs
 <!-- 
+*IMPORTANT* - Please mark logs and text output from terminal commands 
+or else Github will not display them correctly. 
+An example is provided below.
+
 Example:
 ```
 this is an example how log text should be marked (wrap it with ```)