From 5b25813d6cd834211c35733eb80e273c40346188 Mon Sep 17 00:00:00 2001
From: squidfunk <martin.donath@squidfunk.com>
Date: Mon, 16 Sep 2019 10:34:24 +0200
Subject: [PATCH] Revamped issue templates

---
 .github/ISSUE_TEMPLATE.md          | 34 ---------------
 .github/ISSUE_TEMPLATE/bug.md      | 70 ++++++++++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature.md  | 38 ++++++++++++++++
 .github/ISSUE_TEMPLATE/question.md | 12 +++++
 4 files changed, 120 insertions(+), 34 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature.md
 create mode 100644 .github/ISSUE_TEMPLATE/question.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index a162c7bf2..000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,34 +0,0 @@
-## Description
-
-[Description of the bug]
-
-### Expected behavior
-
-[What you expected to happen]
-
-### Actual behavior
-
-[What is actually happening]
-
-### Steps to reproduce the bug
-
-1. [First step]
-2. [Second step]
-3. [and so on...]
-
-### Package versions
-
-* Python: `python --version`
-* MkDocs: `mkdocs --version`
-* Material: `pip show mkdocs-material | grep -E ^Version`
-
-### Project configuration
-
-``` yaml
-The contents of your mkdocs.yml
-```
-
-### System information
-
-* OS: [The operating system you're running]
-* Browser: [The browser used, if relevant]
diff --git a/.github/ISSUE_TEMPLATE/bug.md b/.github/ISSUE_TEMPLATE/bug.md
new file mode 100644
index 000000000..f138da727
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug.md
@@ -0,0 +1,70 @@
+---
+name: Bug
+about: Report a bug
+---
+
+<!--
+  ⚠️ WARNING
+
+  Half of all issues created do not contain enough information to help or are
+  not appropriate for the issue tracker (i.e. one-line questions). If you think
+  you found a bug, follow the steps outlined below closely. Any issue that does
+  not meet these conditions may be closed unnoticed.
+
+  Why? Because the maintainers of this project are wasting a lot of time
+  answering questions that are not directly related to this project.
+-->
+
+__Checklist__:
+
+<!-- Make sure that your request fulfills all of the following requirements -->
+
+I checked that...
+
+- [ ] ... the documentation does not mention anything about my problem
+- [ ] ... the problem doesn't occur with the default MkDocs template
+- [ ] ... the problem is not in any of my customizations (CSS, JS, template)
+- [ ] ... there are no open or closed issues that are related to my problem
+
+## Description
+
+<!-- Please provide a brief description of the bug -->
+
+### Expected behavior
+
+<!-- Please describe what you expected to happen -->
+
+### Actual behavior
+
+<!-- Please describe what is actually happening -->
+
+### Steps to reproduce the bug
+
+<!-- Please provide the steps to repoduce the issue -->
+
+1. ...
+2. ...
+3. ...
+
+### Package versions
+
+<!-- Please provide all package versions -->
+
+* Python: `python --version`
+* MkDocs: `mkdocs --version`
+* Material: `pip show mkdocs-material | grep -E ^Version`
+
+### Project configuration
+
+<!-- Please provide your mkdocs.yml to a REASONABLE amount of detail -->
+
+``` yaml
+The contents of your mkdocs.yml
+```
+
+### System information
+
+<!-- Please provide your operating system and browser version -->
+
+* OS: [The operating system you're running]
+* Browser: [The browser used, if relevant]
diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md
new file mode 100644
index 000000000..faaf09feb
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature.md
@@ -0,0 +1,38 @@
+---
+name: Feature
+about: Suggest an idea
+---
+
+<!--
+  ⚠️ WARNING
+
+  Half of all issues created do not contain enough information to help or are
+  not appropriate for the issue tracker (i.e. one-line questions). If you would
+  like to suggest a feature, follow the steps outlined below closely. Any issue
+  that does not meet these conditions may be closed unnoticed.
+
+  Why? Because the maintainers of this project are wasting a lot of time
+  answering questions that are not directly related to this project.
+-->
+
+__Checklist__:
+
+<!-- Make sure that your request fulfills all of the following requirements -->
+
+I checked that...
+
+- [ ] ... the documentation does not mention anything about my idea
+- [ ] ... to my best knowledge, my idea wouldn't break something for other users
+- [ ] ... there are no open or closed issues that are related to my idea
+
+## Description
+
+<!-- Please provide a brief description of the feature -->
+
+### Use Cases
+
+<!-- Please describe how your suggestion would benefit you and other users -->
+
+### Screenshots / Mockups
+
+<!-- If applicable, provide some mockups or screenshots -->
diff --git a/.github/ISSUE_TEMPLATE/question.md b/.github/ISSUE_TEMPLATE/question.md
new file mode 100644
index 000000000..36bdb7b9e
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/question.md
@@ -0,0 +1,12 @@
+---
+name: Question
+about: The issue tracker is not for questions. Please use the Gitter channel.
+---
+
+__THE ISSUE TRACKER IS NOT FOR QUESTIONS.__  
+__DO NOT CREATE A NEW ISSUE TO ASK A QUESTION.__
+
+Please use the [official Gitter channel][1] to ask your question. Any issues
+that only contain questions
+
+  [1]: https://gitter.im/squidfunk/mkdocs-material