[skip circleci] Add modern issue templates #2394
Conversation
jneira
commented
Nov 24, 2021
•
jneira
commented
- Closes Improve Github Issue Template #388
- Closes Issue template doesn't work (make easier generate bug report info with no executable in path) #621
- Make progress towards HLS not working within GHC (meta improve troubleshooting) #2387
jneira
changed the title
Co-authored-by: fendor <[email protected]>
There was a problem hiding this comment.
If you want to get really fancy, you could use the new issue forms: https://docs.github.com/en/communities/using-templates-to-encourage-useful-issues-and-pull-requests/syntax-for-issue-forms
My main thought is that I think as much as possible we should enhance the troubleshooting page and direct people there, so the information is centralised in one place. I'm hoping to make a PR for some improvements there in a bit!
.github/ISSUE_TEMPLATE/bug_report.md
Outdated
| --> | ||
|
|
||
| ### Your environment | ||
| Output of `haskell-language-server --probe-tools` or `haskell-language-server-wrapper --probe-tools`: |
There was a problem hiding this comment.
This is still useful, no?
There was a problem hiding this comment.
haskell-language-server --debug . also prints the tools, so I think this is indeed superfluous.
| 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)) |
There was a problem hiding this comment.
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"
There was a problem hiding this comment.
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
| @@ -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) | |||
There was a problem hiding this comment.
Again, I think we should refer people to the relevant section of the troubleshooting page.
There was a problem hiding this comment.
hmm https://github.com/haskell/vscode-haskell#troubleshooting would not be the relevant page?
Co-authored-by: Michael Peyton Jones <[email protected]>
wow didnt know about that feature, looks really nice. I think i will give a try |
Co-Authored-by @michaelpj
what do you think revisit the issue template after improving the troubleshooting section and update the links? |
Yes, fine! |
It looks nice but it will take some time to get it right so i think is better to improve content and switch to forms in other pr |
jneira
added
merge me
* Add modern issue templates * Replace with modern issues templates * Mention discussions in the blank issue * Mention explicitly vscode binaries location * Correct grammar Co-authored-by: fendor <[email protected]> * Correct grammar Co-authored-by: Michael Peyton Jones <[email protected]> * Rephrase into Co-Authored-by @michaelpj * they already let you open a blank one * Comment out suggestions Co-authored-by: fendor <[email protected]> Co-authored-by: Michael Peyton Jones <[email protected]> Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
