Skip to content

Commit

Permalink
Create a new issue template for non-VS Code editor users (#2449)
Browse files Browse the repository at this point in the history
  • Loading branch information
st0012 authored Aug 15, 2024
1 parent af60237 commit a9b5515
Show file tree
Hide file tree
Showing 2 changed files with 56 additions and 11 deletions.
46 changes: 46 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_template_non_vscode.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,46 @@
---
name: Ruby LSP bug (non-VS Code editors)
description: File a bug report about the Ruby LSP with non-VS Code editors
labels:
- bug
- non-vscode
- help-wanted
body:
- type: markdown
attributes:
value: |
Thank you for filing a bug report!
Please note that the maintainers only have bandwidth to prioritize VS Code support and lean on the community to assist with supporting other editors.
If you are using a non-VS Code editor, please follow these steps **before submitting a bug report**:
1. Follow the instructions on [troubleshooting](https://github.com/Shopify/ruby-lsp/blob/main/TROUBLESHOOTING.md)
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).
3. Seek help in the [Ruby DX Slack](https://join.slack.com/t/ruby-dx/shared_invite/zt-2c8zjlir6-uUDJl8oIwcen_FS_aA~b6Q).
4. Seek help in the related editor/plugin's issue tracker.
Describing prior discussions and troubleshooting steps will help us understand the issue and respond more quickly.
- type: textarea
attributes:
label: Description
description: Reproduction steps
value: |
### Reproduction steps
<!--
**IMPORTANT NOTE**
Please provide as much detail about your development setup as possible. Often issues with the Ruby LSP are
specific to a combination of operating system, Ruby version, Ruby version manager, the editor being used and
project setup. The easier it is to reproduce the problem, the quicker it will likely take to fix it.
-->
<!-- Suggested structure -->
1. Start the Ruby LSP using a certain editor
2. Open a Ruby file
3. Do something
4. See unexpected behavior
**Code snippet or error message**
```ruby
```
validations:
required: true
Original file line number Diff line number Diff line change
@@ -1,18 +1,15 @@
---
name: Ruby LSP bug
description: File a bug report about the Ruby LSP
name: Ruby LSP bug (VS Code)
description: File a bug report about the Ruby LSP with VS Code
labels:
- bug
- vscode
body:
- type: markdown
attributes:
value: >
Thank you for filing a bug report! Please answer the following questions to help us understand the issue.
- type: textarea
attributes:
label: Description
description: Reproduction steps
value: |
Thank you for filing a bug report! Please answer the following questions to help us understand the issue.
### Before submitting
Please follow the instructions on
Expand All @@ -21,9 +18,11 @@ body:
1. On the latest version of the Ruby LSP VS Code extension
2. On the latest version of the Ruby LSP server gem
3. On the latest version of VS Code
If the issue persist, please deleted this section and submit the report.
- type: textarea
attributes:
label: Description
description: Reproduction steps
value: |
### Reproduction steps
<!--
Expand Down

0 comments on commit a9b5515

Please sign in to comment.