Skip to content

Commit a9b5515

Browse files
authored
Create a new issue template for non-VS Code editor users (#2449)
1 parent af60237 commit a9b5515

File tree

2 files changed

+56
-11
lines changed

2 files changed

+56
-11
lines changed
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,46 @@
1+
---
2+
name: Ruby LSP bug (non-VS Code editors)
3+
description: File a bug report about the Ruby LSP with non-VS Code editors
4+
labels:
5+
- bug
6+
- non-vscode
7+
- help-wanted
8+
body:
9+
- type: markdown
10+
attributes:
11+
value: |
12+
Thank you for filing a bug report!
13+
Please note that the maintainers only have bandwidth to prioritize VS Code support and lean on the community to assist with supporting other editors.
14+
If you are using a non-VS Code editor, please follow these steps **before submitting a bug report**:
15+
16+
1. Follow the instructions on [troubleshooting](https://github.com/Shopify/ruby-lsp/blob/main/TROUBLESHOOTING.md)
17+
2. Check if the editor and LSP plugin you use are up to date, and if they support the latest [Language Server Protocol Specification](https://microsoft.github.io/language-server-protocol).
18+
3. Seek help in the [Ruby DX Slack](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q).
19+
4. Seek help in the related editor/plugin's issue tracker.
20+
21+
Describing prior discussions and troubleshooting steps will help us understand the issue and respond more quickly.
22+
- type: textarea
23+
attributes:
24+
label: Description
25+
description: Reproduction steps
26+
value: |
27+
### Reproduction steps
28+
29+
<!--
30+
**IMPORTANT NOTE**
31+
Please provide as much detail about your development setup as possible. Often issues with the Ruby LSP are
32+
specific to a combination of operating system, Ruby version, Ruby version manager, the editor being used and
33+
project setup. The easier it is to reproduce the problem, the quicker it will likely take to fix it.
34+
-->
35+
36+
<!-- Suggested structure -->
37+
1. Start the Ruby LSP using a certain editor
38+
2. Open a Ruby file
39+
3. Do something
40+
4. See unexpected behavior
41+
42+
**Code snippet or error message**
43+
```ruby
44+
```
45+
validations:
46+
required: true

.github/ISSUE_TEMPLATE/bug_template.yml .github/ISSUE_TEMPLATE/bug_template_vscode.yml

+10-11
Original file line numberDiff line numberDiff line change
@@ -1,18 +1,15 @@
11
---
2-
name: Ruby LSP bug
3-
description: File a bug report about the Ruby LSP
2+
name: Ruby LSP bug (VS Code)
3+
description: File a bug report about the Ruby LSP with VS Code
44
labels:
55
- bug
6+
- vscode
67
body:
78
- type: markdown
89
attributes:
9-
value: >
10-
Thank you for filing a bug report! Please answer the following questions to help us understand the issue.
11-
- type: textarea
12-
attributes:
13-
label: Description
14-
description: Reproduction steps
1510
value: |
11+
Thank you for filing a bug report! Please answer the following questions to help us understand the issue.
12+
1613
### Before submitting
1714
1815
Please follow the instructions on
@@ -21,9 +18,11 @@ body:
2118
1. On the latest version of the Ruby LSP VS Code extension
2219
2. On the latest version of the Ruby LSP server gem
2320
3. On the latest version of VS Code
24-
25-
If the issue persist, please deleted this section and submit the report.
26-
21+
- type: textarea
22+
attributes:
23+
label: Description
24+
description: Reproduction steps
25+
value: |
2726
### Reproduction steps
2827
2928
<!--

0 commit comments

Comments
 (0)