From 320239200d308f180686335b158ae97b1f36a0c9 Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Wed, 24 Nov 2021 13:23:11 +0100
Subject: [PATCH 1/9] Add modern issue templates

---
 .github/ISSUE_TEMPLATE/blank-issue.md     | 10 ++++
 .github/ISSUE_TEMPLATE/bug_report.md      | 57 +++++++++++++++++++++++
 .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++
 3 files changed, 87 insertions(+)
 create mode 100644 .github/ISSUE_TEMPLATE/blank-issue.md
 create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md
 create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md

diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md
new file mode 100644
index 0000000000..7e48b678a2
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/blank-issue.md
@@ -0,0 +1,10 @@
+---
+name: Blank issue
+about: An empty template for other type of issues
+title: ''
+labels: 'status: needs triage'
+assignees: ''
+
+---
+
+
diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
new file mode 100644
index 0000000000..cba8cb9b79
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -0,0 +1,57 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: 'status: needs triage, type: bug'
+assignees: ''
+
+---
+
+<!--
+If you encounter a bug or you have a support question, please try to fill out some of the information below.
+Please take a look to the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html) before filling this new one.
+The information below is meant to help debugging issues but is no prerequisite for opening an issue.
+-->
+
+### Your environment
+
+Which OS do you use:
+<!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
+Which lsp-client do you use:
+<!-- Neovim, emacs, VS Codium, etc... -->
+Describe your project (alternative: link to the project):
+<!-- stack.yaml, package.yaml, *.cabal files, cabal.project, hie.yaml -->
+
+### Steps to reproduce
+<!-- Tell us how to reproduce this issue. -->
+
+### Expected behaviour
+<!-- Tell us what should happen. -->
+
+### Actual behaviour
+<!-- Tell us what happens instead. -->
+
+### Include debug information
+Execute in the root of your project the command `haskell-language-server-wrapper --debug .` or `haskell-language-server --debug .` and paste the logs here:
+
+<details>
+<summary>
+Debug output:
+</summary>
+
+```
+<paste your logs here>
+```
+</details>
+
+Paste the logs from the lsp-client, you can check instructions about for VS Code [here](https://github.com/haskell/vscode-haskell#troubleshooting)
+
+<details>
+<summary>
+LSP logs:
+</summary>
+
+```
+<paste your logs here>
+```
+</details>
diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
new file mode 100644
index 0000000000..a05cf11383
--- /dev/null
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: 'status: needs triage, type: enhancement'
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

From 96d8044f1221baa11307a9c1f77708a9e271f094 Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Wed, 24 Nov 2021 13:25:47 +0100
Subject: [PATCH 2/9] Replace with modern issues templates

---
 .github/ISSUE_TEMPLATE.md | 55 ---------------------------------------
 1 file changed, 55 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE.md

diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
deleted file mode 100644
index f7949a11f2..0000000000
--- a/.github/ISSUE_TEMPLATE.md
+++ /dev/null
@@ -1,55 +0,0 @@
-<!--
-If you encounter a bug or you have a support question, please try to fill out some of the information below.
-Generally speaking, the information below is meant to help debugging issues but is no prerequisite for opening an issue.
--->
-
-### Your environment
-Output of `haskell-language-server --probe-tools` or `haskell-language-server-wrapper --probe-tools`:
-<!-- This command is available since version `>= 0.4.0.0` -->
-```sh
-
-```
-Which OS do you use:
-<!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
-Which lsp-client do you use:
-<!-- Neovim, emacs, VS Codium, etc... -->
-Describe your project (alternative: link to the project):
-<!-- stack.yaml, package.yaml, *.cabal files, cabal.project -->
-Contents of `hie.yaml`:
-```yaml
-
-```
-
-### Steps to reproduce
-<!-- Tell us how to reproduce this issue. -->
-
-### Expected behaviour
-<!-- Tell us what should happen. -->
-
-### Actual behaviour
-<!-- Tell us what happens instead. -->
-
-### Include debug information
-Execute in the root of your project the command `haskell-language-server --debug .` and paste the logs here:
-
-<details>
-<summary>
-Debug output:
-</summary>
-
-```
-<paste your logs here>
-```
-</details>
-
-Paste the logs from the lsp-client, e.g. for [VS Code](https://github.com/haskell/vscode-haskell#troubleshooting)
-
-<details>
-<summary>
-LSP logs:
-</summary>
-
-```
-<paste your logs here>
-```
-</details>

From e3844c0ab086dbb7f28bcd6db75c6379a1283a78 Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Wed, 24 Nov 2021 13:31:04 +0100
Subject: [PATCH 3/9] Mention discussions in the blank issue

---
 .github/ISSUE_TEMPLATE/blank-issue.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md
index 7e48b678a2..c906ad0c0d 100644
--- a/.github/ISSUE_TEMPLATE/blank-issue.md
+++ b/.github/ISSUE_TEMPLATE/blank-issue.md
@@ -7,4 +7,4 @@ assignees: ''
 
 ---
 
-
+<!-- Note the project has a discussions section which can be used for ask questions, make general proposals or discussions, etc -->

From d400357a2c68f855b04320dee456b3e263c6fedd Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Wed, 24 Nov 2021 13:37:04 +0100
Subject: [PATCH 4/9] Mention explicitly vscode binaries location

---
 .github/ISSUE_TEMPLATE/bug_report.md | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index cba8cb9b79..30d3b0abac 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -32,8 +32,8 @@ Describe your project (alternative: link to the project):
 <!-- Tell us what happens instead. -->
 
 ### Include debug information
-Execute in the root of your project the command `haskell-language-server-wrapper --debug .` or `haskell-language-server --debug .` and paste the logs here:
-
+Execute in the root of your project the command `haskell-language-server-wrapper --debug .` and paste the logs here:
+(if you are using the vscode extension check the executable location [here](https://github.com/haskell/vscode-haskell#downloaded-binaries))
 <details>
 <summary>
 Debug output:

From 4ac4305fc5cecbfc8fd8856b4b14c1ac1bfbf59b Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Wed, 24 Nov 2021 13:52:33 +0100
Subject: [PATCH 5/9] Correct grammar

Co-authored-by: fendor <fendor@users.noreply.github.com>
---
 .github/ISSUE_TEMPLATE/bug_report.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 30d3b0abac..457ed93558 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -9,7 +9,7 @@ assignees: ''
 
 <!--
 If you encounter a bug or you have a support question, please try to fill out some of the information below.
-Please take a look to the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html) before filling this new one.
+Please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html) before filing a new issue.
 The information below is meant to help debugging issues but is no prerequisite for opening an issue.
 -->
 

From 1d90a0172a3a9c6233b9dd75f3f82cbe0993c21e Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Wed, 24 Nov 2021 20:35:41 +0100
Subject: [PATCH 6/9] Correct grammar

Co-authored-by: Michael Peyton Jones <me@michaelpj.com>
---
 .github/ISSUE_TEMPLATE/blank-issue.md | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md
index c906ad0c0d..384f20317e 100644
--- a/.github/ISSUE_TEMPLATE/blank-issue.md
+++ b/.github/ISSUE_TEMPLATE/blank-issue.md
@@ -7,4 +7,4 @@ assignees: ''
 
 ---
 
-<!-- Note the project has a discussions section which can be used for ask questions, make general proposals or discussions, etc -->
+<!-- Note the project has a discussions section which can be used to ask questions, make general proposals or discussions, etc -->

From 1290d1df68dc6345038b681fd0fe583aa62298e9 Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Wed, 24 Nov 2021 20:45:57 +0100
Subject: [PATCH 7/9] Rephrase into

Co-Authored-by @michaelpj
---
 .github/ISSUE_TEMPLATE/bug_report.md | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md
index 457ed93558..5674ee4522 100644
--- a/.github/ISSUE_TEMPLATE/bug_report.md
+++ b/.github/ISSUE_TEMPLATE/bug_report.md
@@ -8,9 +8,9 @@ assignees: ''
 ---
 
 <!--
-If you encounter a bug or you have a support question, please try to fill out some of the information below.
-Please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html) before filing a new issue.
-The information below is meant to help debugging issues but is no prerequisite for opening an issue.
+Before opening an issue, please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html). This explains some common issues and will also help you to find the information that the issue template asks for.
+
+When filing an issue, please fill out as much of the information below as you can. This helps us to debug your issue, but is not required!
 -->
 
 ### Your environment

From 29bec179795c110f9555855a713b9ac10419dd0d Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Thu, 25 Nov 2021 22:50:51 +0100
Subject: [PATCH 8/9] they already let you open a blank one

---
 .github/ISSUE_TEMPLATE/blank-issue.md | 10 ----------
 1 file changed, 10 deletions(-)
 delete mode 100644 .github/ISSUE_TEMPLATE/blank-issue.md

diff --git a/.github/ISSUE_TEMPLATE/blank-issue.md b/.github/ISSUE_TEMPLATE/blank-issue.md
deleted file mode 100644
index 384f20317e..0000000000
--- a/.github/ISSUE_TEMPLATE/blank-issue.md
+++ /dev/null
@@ -1,10 +0,0 @@
----
-name: Blank issue
-about: An empty template for other type of issues
-title: ''
-labels: 'status: needs triage'
-assignees: ''
-
----
-
-<!-- Note the project has a discussions section which can be used to ask questions, make general proposals or discussions, etc -->

From 02373812106ee008743de044290ac3146724b972 Mon Sep 17 00:00:00 2001
From: Javier Neira <atreyu.bbb@gmail.com>
Date: Thu, 25 Nov 2021 22:53:03 +0100
Subject: [PATCH 9/9] Comment out suggestions

---
 .github/ISSUE_TEMPLATE/feature_request.md | 12 ++++++++----
 1 file changed, 8 insertions(+), 4 deletions(-)

diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md
index a05cf11383..475681f707 100644
--- a/.github/ISSUE_TEMPLATE/feature_request.md
+++ b/.github/ISSUE_TEMPLATE/feature_request.md
@@ -8,13 +8,17 @@ assignees: ''
 ---
 
 **Is your feature request related to a problem? Please describe.**
-A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->
 
 **Describe the solution you'd like**
-A clear and concise description of what you want to happen.
+
+<!-- A clear and concise description of what you want to happen. -->
 
 **Describe alternatives you've considered**
-A clear and concise description of any alternative solutions or features you've considered.
+
+<!-- A clear and concise description of any alternative solutions or features you've considered. -->
 
 **Additional context**
-Add any other context or screenshots about the feature request here.
+
+<!-- Add any other context or screenshots about the feature request here. -->