Skip to content

Commit

Permalink
Update issue templates
Browse files Browse the repository at this point in the history
- 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
  • Loading branch information
michaelpj committed Jul 18, 2022
1 parent 2f886bf commit 0d35ab8
Show file tree
Hide file tree
Showing 3 changed files with 64 additions and 16 deletions.
29 changes: 19 additions & 10 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,47 @@
---
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: ''

---

<!--
Before opening an issue, please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html).
Before opening a bug, 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

Which OS do you use:
<!--
Everything in this section is optional, but it does help us to debug your issue!
-->

Which OS do you use?
<!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
Which LSP client (editor/plugin) do you use:
Which version of GHC do you use and how did you install it?
<!-- 9.0.2 from stack/ghcup, etc. -->
How is your project built (alternative: link to the project)?

Which LSP client (editor/plugin) do you use?
<!-- Neovim+LanguageClient-neovim, emacs+lsp-mode, VS Codium+vscode-haskell, etc... -->
Describe your project (alternative: link to the project):
<!-- stack.yaml, package.yaml, *.cabal files, cabal.project, hie.yaml -->
Which version of HLS do you use and how did you install it?
<!-- 1.7.0.1 from ghcup, etc. -->
Have you configured HLS in any way (especially: a `hie.yaml` file)?

### 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
### Debug information

<!-- Include any useful debug information, such as relevant log snippets. -->
Original file line number Diff line number Diff line change
@@ -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.

<!-- A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] -->

**Describe the solution you'd like**
## Describe the solution you'd like

<!-- A clear and concise description of what you want to happen. -->

**Describe alternatives you've considered**
## Describe alternatives you've considered

<!-- A clear and concise description of any alternative solutions or features you've considered. -->

**Additional context**
## Additional context

<!-- Add any other context or screenshots about the feature request here. -->
39 changes: 39 additions & 0 deletions .github/ISSUE_TEMPLATE/support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
---
name: Support request
about: Help, something isn't working and I'm stuck!
title: ''
labels: 'status: needs triage, type: support'
assignees: ''

---

<!--
Before asking for support, 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.
-->

## Your environment

<!--
Everything in this section is optional, but it does help us to debug your issue!
-->

Which OS do you use?
<!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
Which version of GHC do you use and how did you install it?
<!-- 9.0.2 from stack/ghcup, etc. -->
How is your project built (alternative: link to the project)?

Which LSP client (editor/plugin) do you use?
<!-- Neovim+LanguageClient-neovim, emacs+lsp-mode, VS Codium+vscode-haskell, etc... -->
Which version of HLS do you use and how did you install it?
<!-- 1.7.0.1 from ghcup, etc. -->
Have you configured HLS in any way (especially: a `hie.yaml` file)?

## What's wrong?

<!-- What's not working? What have you tried? -->

### Debug information

<!-- Include any useful debug information, such as relevant log snippets. -->

0 comments on commit 0d35ab8

Please sign in to comment.