Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Create a new issue template for non-VS Code editor users #2449

Merged
merged 1 commit into from
Aug 15, 2024

Conversation

st0012
Copy link
Member

@st0012 st0012 commented Aug 15, 2024

Motivation

To make sure we can properly report and investigate issues for the Ruby LSP project, we need to create two different templates: one for VS Code and another for non-VS Code editors. Here's why:

  1. Maintainer Expertise: Our maintainers mainly use VS Code and don't have setups for other editors. This means we can give better guidance and support for issues in VS Code but not as much for other editors.

  2. LSP Compatibility: Different editors and their LSP plugins might not always be up-to-date with the latest LSP specs. This can cause differences in how issues show up between VS Code and other editors.

  3. Reporting Tools: Our VS Code extension has specific tools for reporting issues, like a status panel and an addons list, which aren't available in other editors. These tools are super helpful for diagnosing and fixing issues in VS Code.

By having separate templates, we can make the issue reporting process clearer and get the most relevant info for each setup.

Implementation

Automated Tests

Manual Tests

@st0012 st0012 self-assigned this Aug 15, 2024
@st0012 st0012 requested a review from a team as a code owner August 15, 2024 15:58
@st0012 st0012 requested review from andyw8 and vinistock August 15, 2024 15:58
@st0012 st0012 force-pushed the add-bug-template-for-non-vscode-issues branch from a95ef61 to a2405f2 Compare August 15, 2024 17:13
@st0012 st0012 added the chore Chore task label Aug 15, 2024
@vinistock
Copy link
Member

I understand the goal behind this, but I do have one concern. When we had different repositories for the VS Code extension and the server, it became clear to us that users don't really know when a bug is in one or the other (nor do they have to know).

If we create two separate bug templates (VS Code vs other editors), a similar situation may occur. For example, if someone using an editor other than VS Code discovers a bug in the server (which impacts all editors), this will increase the likelihood that it will be reported as a non VS Code bug.

How do we handle that scenario? Is the idea that we will still triage issues reported about other editors to ensure that they're not server bugs? And if that's the case, in what way is that different than our current triage?

@st0012
Copy link
Member Author

st0012 commented Aug 15, 2024

@vinistock The main goal here is to set a clearer expectation and steps to follow to users who want to report issues.

If a problem is on server and is reported by non-VS Code users, there are 2 scenarios:

  1. It's affecting VS Code users too
  2. Somehow it doesn't affect VS Code (like the problem described in Fix Ruby LSP formatting range to comply with LSP specification #2438?)

For 1, we should receive issue report from VS Code users anyway so we won't miss any signal.
For 2, if users do follow the instructions to have discussions on Slack or other issue trackers first, that additional information should help us investigate issues.

Is the idea that we will still triage issues reported about other editors to ensure that they're not server bugs? And if that's the case, in what way is that different than our current triage?

So yes, we still triage all issues but prioritize issues with vscode labels. And in the meantime, if users do follow the instructions, non-vscode issues should be reported a bit less frequently but also has richer context when it's opened.

Copy link
Member

@vinistock vinistock left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's give it a try and see how it works

@st0012 st0012 merged commit a9b5515 into main Aug 15, 2024
35 of 36 checks passed
@st0012 st0012 deleted the add-bug-template-for-non-vscode-issues branch August 15, 2024 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
chore Chore task
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants