Update issue template and troubleshooting instructions (elixir-lsp#127)

dgutov · Feb 29, 2020 · 5039e22 · 5039e22
1 parent d70719c
commit 5039e22
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 0 deletions.
diff --git a/.github/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md
@@ -6,6 +6,12 @@
 * LSP Client name: 
 * If using VSCode, are you using "ElixirLS Fork: Elixir support and debugger" (note that it has "Fork" in the name)? 
 
+### Troubleshooting
+
+- [ ] Restart your editor (which will restart ElixirLS) sometimes fixes issues
+- [ ] Stop your editor, remove the entire `.elixir_ls` directory, then restart your editor
+  * NOTE: This will cause you to have to re-run the entire dialyzer build
+
 ### Crash report template
 
 _Delete this section if not reporting a crash_

diff --git a/README.md b/README.md
@@ -119,6 +119,7 @@ If your code doesn't compile in ElixirLS, it may be because ElixirLS compiles co
 
 * `.exs` files don't return compilation errors
 * `workspaceSymbolProvider` capability currently requires enabled dialyzer
+* "Fetching n dependencies" sometimes get stuck (remove the `.elixir_ls` directory to fix)
 
 ## Building and running