Skip to content

Commit 8019589

Browse files
authored
Update issue template
1 parent 2670665 commit 8019589

File tree

1 file changed

+31
-11
lines changed

1 file changed

+31
-11
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 31 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,41 @@
1+
### Precheck
2+
3+
* Do a quick search and make sure the issue has not yet been reported
4+
* Do not use the issues tracker for guidance, questions or support (try Elixir Forum, Stack Overflow, Slack, etc. instead)
5+
* If using a client other than VS Code, please try VSCode's "ElixirLS: Elixir support and debugger" extension. Does it reproduce your failure?
6+
17
### Environment
28

39
* Elixir & Erlang versions (elixir --version):
10+
* Elixir Language Server version:
411
* Operating system:
512
* Editor or IDE name (e.g. Emacs/VSCode):
6-
* Editor Plugin/LSP Client name:
13+
* Editor Plugin/LSP Client name and version:
14+
15+
### Current behavior
16+
17+
<!--
18+
A short description of the issue
19+
-->
20+
21+
<!--
22+
ElixirLS logs. If using Visual Studio Code, check the output log by opening `View > Output` and selecting "ElixirLS" in the dropdown. Please include any output that looks relevant. (If ElixirLS isn't in the dropdown, the server failed to launch.)
23+
-->
724

8-
### Troubleshooting
25+
<!--
26+
If relevant include VSCode extension logs. Check the developer console by opening `Help > Toggle Developer Tools`.
27+
-->
928

10-
- [ ] Restart your editor (which will restart ElixirLS) sometimes fixes issues
11-
- [ ] Stop your editor, remove the entire `.elixir_ls` directory, then restart your editor
12-
* NOTE: This will cause you to have to re-run the dialyzer build for your project
29+
<!--
30+
If relevant include Language Server Protocol/Debug Adapter Protocol messages trace. In VSCode turn on tracing in Settings > Extensions > ElixirLS > Elixir LS › Trace: Server.
31+
-->
1332

14-
If you're experiencing high CPU usage, it is most likely Dialyzer building the PLTs; after it's done the CPU usage should go back to normal. You could also disable Dialyzer in the settings.
33+
<!--
34+
Reproduction steps. Describe how to reproduce the issue with an empty mix project or post a minimal repo with a project that reproduces the issue.
35+
-->
1536

16-
### Logs
37+
### Expected behavior
1738

18-
1. If using a client other than VS Code, please try VSCode's "ElixirLS: Elixir support and debugger" extension. Does it reproduce your failure?
19-
2. Create a new Mix project with `mix new empty`, then open that project with VS Code and open an Elixir file. Is your issue reproducible on the empty project? If not, please publish a repo on Github that does reproduce it.
20-
3. Check the output log by opening `View > Output` and selecting "ElixirLS" in the dropdown. Please include any output that looks relevant. (If ElixirLS isn't in the dropdown, the server failed to launch.)
21-
4. Check the developer console by opening `Help > Toggle Developer Tools` and include any errors that look relevant.
39+
<!--
40+
A short description on how you expect the language server/debug adapter to behave.
41+
-->

0 commit comments

Comments
 (0)