Skip to content

Commit 42fe9b2

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

File tree

2 files changed

+44
-2
lines changed

2 files changed

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

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

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
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
66
body:

0 commit comments

Comments
 (0)