Skip to content

Commit 0d243c1

Browse files
committed
Create a new issue template for non-VS Code editor users
1 parent e18d456 commit 0d243c1

File tree

2 files changed

+53
-9
lines changed

2 files changed

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

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

+10-9
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
@@ -23,7 +20,11 @@ body:
2320
3. On the latest version of VS Code
2421
2522
If the issue persist, please deleted this section and submit the report.
26-
23+
- type: textarea
24+
attributes:
25+
label: Description
26+
description: Reproduction steps
27+
value: |
2728
### Reproduction steps
2829
2930
<!--

0 commit comments

Comments
 (0)