From d90860792f2051859643fac245c6d798bc6822d0 Mon Sep 17 00:00:00 2001 From: Michael Peyton Jones Date: Sun, 17 Jul 2022 17:23:07 +0100 Subject: [PATCH] Update issue templates - Add a support issue template - Ask questions about versions of GHC and HLS - Add some heuristic details fields to help people pick an issue type --- .github/ISSUE_TEMPLATE/bug_report.md | 21 +++++++---- ...ture_request.md => enhancement_request.md} | 12 +++--- .github/ISSUE_TEMPLATE/support.md | 37 +++++++++++++++++++ 3 files changed, 57 insertions(+), 13 deletions(-) rename .github/ISSUE_TEMPLATE/{feature_request.md => enhancement_request.md} (63%) create mode 100644 .github/ISSUE_TEMPLATE/support.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index c986cee4300..3fa3caf62fd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,6 +1,6 @@ --- name: Bug report -about: Create a report to help us improve +about: I've spotted something specific thats' going wrong title: '' labels: 'status: needs triage, type: bug' assignees: '' @@ -8,31 +8,38 @@ assignees: '' --- ### Your environment -Which OS do you use: +Which OS do you use? -Which LSP client (editor/plugin) do you use: +Which LSP client (editor/plugin) do you use? -Describe your project (alternative: link to the project): +Which version of HLS do you use and how did you install it? + +Which version of GHC do you use and how did you install it? + +How is your project set up (alternative: link to the project)? ### Steps to reproduce + ### Expected behaviour + ### Actual behaviour + -### Include debug information +### Debug information diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/enhancement_request.md similarity index 63% rename from .github/ISSUE_TEMPLATE/feature_request.md rename to .github/ISSUE_TEMPLATE/enhancement_request.md index 475681f7073..c22b63bc52a 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/enhancement_request.md @@ -1,24 +1,24 @@ --- -name: Feature request -about: Suggest an idea for this project +name: Enhancement request +about: I have an idea for how to make things better title: '' labels: 'status: needs triage, type: enhancement' assignees: '' --- -**Is your feature request related to a problem? Please describe.** +## Is your enhancement request related to a problem? Please describe. -**Describe the solution you'd like** +## Describe the solution you'd like -**Describe alternatives you've considered** +## Describe alternatives you've considered -**Additional context** +## Additional context diff --git a/.github/ISSUE_TEMPLATE/support.md b/.github/ISSUE_TEMPLATE/support.md new file mode 100644 index 00000000000..bb817496a24 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/support.md @@ -0,0 +1,37 @@ +--- +name: Support request +about: Help, something isn't working and I'm stuck! +title: '' +labels: 'status: needs triage, type: support' +assignees: '' + +--- + + + +## Your environment + +Which OS do you use? + +Which LSP client (editor/plugin) do you use? + +Which version of HLS do you use and how did you install it? + +Which version of GHC do you use and how did you install it? + +How is your project set up (alternative: link to the project)? + + +## What's wrong? + + + +### Debug information + +