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

chore: update bug issue template #417

Merged
merged 3 commits into from
Aug 17, 2022
Merged

chore: update bug issue template #417

merged 3 commits into from
Aug 17, 2022

Conversation

ota-meshi
Copy link
Member

Which issue, if any, is this issue related to?

None.

Is there anything in the PR that needs further explanation?

This PR updates the bug issue template to require a reproduction repository to be provided.

Many of the currently open issues are not reproducible as no repositories have been provided to reproduce the issue.

@ota-meshi ota-meshi changed the title chore: update bug template chore: update bug issue template Aug 16, 2022
Copy link
Member

@ybiquitous ybiquitous left a comment

Choose a reason for hiding this comment

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

The change sounds good to me, although I've left some comments for improvement. 👍🏼


[suggest] Is it easier to enter to put the new field after the reproduction-steps field?

  1. Write reproduction steps
  2. Paste a reproduction URL
  3. ...

.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/bug.yml Outdated Show resolved Hide resolved
ota-meshi and others added 2 commits August 16, 2022 11:47
Co-authored-by: Masafumi Koba <473530+ybiquitous@users.noreply.github.com>
@ota-meshi
Copy link
Member Author

Thank you for your review.

[suggest] Is it easier to enter to put the new field after the reproduction-steps field?

True, I think it's easier to put it after reproduction-steps, as you say:+1:. I moved it.

Copy link
Member

@ybiquitous ybiquitous left a comment

Choose a reason for hiding this comment

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

Thank you. LGTM 👍🏼

attributes:
label: Link to Minimal Reproducible Example
description: |
Create a minimal reproduction of the problem. **A minimal reproduction is required** so that others can help debug your issue. If a report is vague (e.g. just a generic error message) and has no reproduction, it may be closed.
Copy link
Member

Choose a reason for hiding this comment

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

[suggest] How about emphasizing a reproduction URL like this, though it seems a bit too long? 🤔

Suggested change
Create a minimal reproduction of the problem. **A minimal reproduction is required** so that others can help debug your issue. If a report is vague (e.g. just a generic error message) and has no reproduction, it may be closed.
Provide a minimal reproduction URL like a GitHub repository or a StackBlitz project. **A minimal reproduction is required** so that others can help debug your issue. If a report is vague (e.g. just a generic error message) and has no reproduction, it may be closed.

Seems better if a shorter description would be good (one sentence if possible), but I don't have any good idea... 😓 (feel free to ignore this suggestion)

Copy link
Member

Choose a reason for hiding this comment

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

@jeddy3 Any ideas?

Copy link
Member Author

Choose a reason for hiding this comment

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

Off topic, but I'm afraid StackBlitz can't run vscode extensions, unlike GitHub Codespaces.

Copy link
Member

Choose a reason for hiding this comment

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

I see. Indeed, StackBlitz doesn't support 3rd-party extensions.

It seems GitHub Codespaces deprecates public access, so a GitHub repository is most suitable as a reproduction environment.

@jeddy3
Copy link
Member

jeddy3 commented Aug 16, 2022

Many of the currently open issues are not reproducible as no repositories have been provided to reproduce the issue.

Are they reproducible using the 3 specific fields:

  • Code Snippet
  • Stylelint Configuration
  • Extension Configuration

If not, what extra specific information is missing? We can add a field(s) for that/those.

We can close any (existing and new) issues that don't supply enough information to reproduce the issue by saying they can reopen the issue by providing more info or a MRE. That's what we do in the main Stylelint issue tracker. Having said that, I haven't touched this repo much so feel to merge this pull request if the change in it works best for you.

@ota-meshi
Copy link
Member Author

ota-meshi commented Aug 17, 2022

If not, what extra specific information is missing?

I can't pinpoint the cause. I think using the configuration they provide will work fine in most cases.

We can close any (existing and new) issues that don't supply enough information to reproduce the issue by saying they can reopen the issue by providing more info or a MRE.

I've had bad experiences before, so I don't want to communicate with users of this extension as much as possible.
If I know the cause immediately, I can fix it or present a solution and close it.

@ota-meshi ota-meshi merged commit a75db3d into main Aug 17, 2022
@ota-meshi ota-meshi deleted the update-bug-template branch August 17, 2022 01:17
@ybiquitous
Copy link
Member

@ota-meshi Thanks for trying to maintain the repository! 😄
Honestly, I've not touched this repository much, but I'll help you if any.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants