Skip to content

[skip circleci] Add modern issue templates #2394

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 13 commits into from
Nov 29, 2021
10 changes: 10 additions & 0 deletions .github/ISSUE_TEMPLATE/blank-issue.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
---
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 for ask questions, make general proposals or discussions, etc -->
Original file line number Diff line number Diff line change
@@ -1,24 +1,26 @@
---
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.
Generally speaking, the information below is meant to help debugging issues but is no prerequisite for opening an issue.
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.
-->

### Your environment
Output of `haskell-language-server --probe-tools` or `haskell-language-server-wrapper --probe-tools`:
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is still useful, no?

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

haskell-language-server --debug . also prints the tools, so I think this is indeed superfluous.

<!-- 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

```
<!-- stack.yaml, package.yaml, *.cabal files, cabal.project, hie.yaml -->

### Steps to reproduce
<!-- Tell us how to reproduce this issue. -->
Expand All @@ -30,8 +32,8 @@ Contents of `hie.yaml`:
<!-- 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:

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))
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I wonder if we should just write more about this on the troubleshooting page, and then here we could say "If you don't know where to find the haskell-language-server exectuable, consult the troubleshooting page"

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, although a direct reference to the location may be helpful too? I mean, we are linking the troubleshooting page in the beginning but in this point the focus is locate it and the table linked gives you the path

<details>
<summary>
Debug output:
Expand All @@ -42,7 +44,7 @@ Debug output:
```
</details>

Paste the logs from the lsp-client, e.g. for [VS Code](https://github.com/haskell/vscode-haskell#troubleshooting)
Paste the logs from the lsp-client, you can check instructions about for VS Code [here](https://github.com/haskell/vscode-haskell#troubleshooting)
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Again, I think we should refer people to the relevant section of the troubleshooting page.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

hmm https://github.com/haskell/vscode-haskell#troubleshooting would not be the relevant page?


<details>
<summary>
Expand Down
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -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.