Skip to content

Commit 0d35ab8

Browse files
committed
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
1 parent 2f886bf commit 0d35ab8

File tree

3 files changed

+64
-16
lines changed

3 files changed

+64
-16
lines changed

Diff for: .github/ISSUE_TEMPLATE/bug_report.md

+19-10
Original file line numberDiff line numberDiff line change
@@ -1,38 +1,47 @@
11
---
22
name: Bug report
3-
about: Create a report to help us improve
3+
about: I've spotted something specific thats' going wrong
44
title: ''
55
labels: 'status: needs triage, type: bug'
66
assignees: ''
77

88
---
99

1010
<!--
11-
Before opening an issue, please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html).
11+
Before opening a bug, please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html).
1212
This explains some common issues and will also help you to find the information that the issue template asks for.
13-
14-
When filing an issue, please fill out as much of the information below as you can.
15-
This helps us to debug your issue, but is not required!
1613
-->
1714

1815
### Your environment
1916

20-
Which OS do you use:
17+
<!--
18+
Everything in this section is optional, but it does help us to debug your issue!
19+
-->
20+
21+
Which OS do you use?
2122
<!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
22-
Which LSP client (editor/plugin) do you use:
23+
Which version of GHC do you use and how did you install it?
24+
<!-- 9.0.2 from stack/ghcup, etc. -->
25+
How is your project built (alternative: link to the project)?
26+
27+
Which LSP client (editor/plugin) do you use?
2328
<!-- Neovim+LanguageClient-neovim, emacs+lsp-mode, VS Codium+vscode-haskell, etc... -->
24-
Describe your project (alternative: link to the project):
25-
<!-- stack.yaml, package.yaml, *.cabal files, cabal.project, hie.yaml -->
29+
Which version of HLS do you use and how did you install it?
30+
<!-- 1.7.0.1 from ghcup, etc. -->
31+
Have you configured HLS in any way (especially: a `hie.yaml` file)?
2632

2733
### Steps to reproduce
34+
2835
<!-- Tell us how to reproduce this issue. -->
2936

3037
### Expected behaviour
38+
3139
<!-- Tell us what should happen. -->
3240

3341
### Actual behaviour
42+
3443
<!-- Tell us what happens instead. -->
3544

36-
### Include debug information
45+
### Debug information
3746

3847
<!-- Include any useful debug information, such as relevant log snippets. -->
Original file line numberDiff line numberDiff line change
@@ -1,24 +1,24 @@
11
---
2-
name: Feature request
3-
about: Suggest an idea for this project
2+
name: Enhancement request
3+
about: I have an idea for how to make things better
44
title: ''
55
labels: 'status: needs triage, type: enhancement'
66
assignees: ''
77

88
---
99

10-
**Is your feature request related to a problem? Please describe.**
10+
## Is your enhancement request related to a problem? Please describe.
1111

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

14-
**Describe the solution you'd like**
14+
## Describe the solution you'd like
1515

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

18-
**Describe alternatives you've considered**
18+
## Describe alternatives you've considered
1919

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

22-
**Additional context**
22+
## Additional context
2323

2424
<!-- Add any other context or screenshots about the feature request here. -->

Diff for: .github/ISSUE_TEMPLATE/support.md

+39
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: Support request
3+
about: Help, something isn't working and I'm stuck!
4+
title: ''
5+
labels: 'status: needs triage, type: support'
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Before asking for support, please take a look at the [troubleshooting guide](https://haskell-language-server.readthedocs.io/en/latest/troubleshooting.html).
12+
This explains some common issues and will also help you to find the information that the issue template asks for.
13+
-->
14+
15+
## Your environment
16+
17+
<!--
18+
Everything in this section is optional, but it does help us to debug your issue!
19+
-->
20+
21+
Which OS do you use?
22+
<!-- Windows, MacOS, Ubuntu, ArchLinux, etc... -->
23+
Which version of GHC do you use and how did you install it?
24+
<!-- 9.0.2 from stack/ghcup, etc. -->
25+
How is your project built (alternative: link to the project)?
26+
27+
Which LSP client (editor/plugin) do you use?
28+
<!-- Neovim+LanguageClient-neovim, emacs+lsp-mode, VS Codium+vscode-haskell, etc... -->
29+
Which version of HLS do you use and how did you install it?
30+
<!-- 1.7.0.1 from ghcup, etc. -->
31+
Have you configured HLS in any way (especially: a `hie.yaml` file)?
32+
33+
## What's wrong?
34+
35+
<!-- What's not working? What have you tried? -->
36+
37+
### Debug information
38+
39+
<!-- Include any useful debug information, such as relevant log snippets. -->

0 commit comments

Comments
 (0)