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

Maintenance: Improve issue templates #14543

Merged
merged 2 commits into from
Apr 16, 2021
Merged

Maintenance: Improve issue templates #14543

merged 2 commits into from
Apr 16, 2021

Conversation

shilman
Copy link
Member

@shilman shilman commented Apr 10, 2021

Issue: N/A

What I did

  • Add a question template
  • Add labels to issues based on template
  • Prompt users for repro repo in bug report
  • Add link to discord

Rationale:

  • Moving towards a model where bug repros are required by default (with an official repro template TBD)
  • Move away from github discussions, which don't support labels
  • Prepare for a distributed triage process

How to test

N/A

@shilman shilman added the maintenance User-facing maintenance tasks label Apr 10, 2021
about: Create a report to help us improve
name: Bug report 🐞
about: Something is broken and you have a reliable reproduction? Let us know here. For questions, please use "Question" below.
labels: needs triage, bug
Copy link
Contributor

Choose a reason for hiding this comment

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

Any chance we can can ask the framework to the user ? I don't have idea how though :)

Copy link
Member

Choose a reason for hiding this comment

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

In the System section below we ask users to run npx sb@next info, which will output the @storybook/<framework> package installed and that helps to know the framework, but I'm not sure if you're asking this or you mean asking users to add an issue label like app:<framework> 🤔

Copy link
Member

Choose a reason for hiding this comment

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

If we want the label to be automatically set based on the issue's description we can create a simple GitHub Action that will "parse" the System section to find out the SB framework (and version) used and set labels accordingly. But it would not be very relevant in cases of bugs in an addon 🤔

about: Create a report to help us improve
name: Bug report 🐞
about: Something is broken and you have a reliable reproduction? Let us know here. For questions, please use "Question" below.
labels: needs triage, bug
Copy link
Member

Choose a reason for hiding this comment

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

If we want the label to be automatically set based on the issue's description we can create a simple GitHub Action that will "parse" the System section to find out the SB framework (and version) used and set labels accordingly. But it would not be very relevant in cases of bugs in an addon 🤔

Co-authored-by: Yann Braga <yannbf@gmail.com>
@shilman shilman merged commit e79f12f into next Apr 16, 2021
@shilman shilman deleted the dx-improve-issue-templates branch April 16, 2021 16:17
---

**What's the problem?**
Clear and concise statement of what's troubling you.
Copy link
Member

Choose a reason for hiding this comment

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

This is pretty open-ended, which can end up being yield issues that are noisy/generic that we'd then have to close.

If the idea here is to point out areas to improve documentation, perhaps we change the template name to "Request documentation".

If the questions are in fact generic "how to", I'd suggest we use Stack Overflow or Discord instead of creating a GH issue.

Copy link
Member Author

Choose a reason for hiding this comment

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

I agree that request documentation is more specific. I'll update it to steer people in that direction.

Regarding actual questions, I don't want to introduce yet another system that needs to be triaged. Discord is fine because we already support it. However, my impression is that those answers are very temporal and are pretty much lost into the ether after a day or so. Stack overflow is kind of exactly what we want, but we're setting up a triage process for Github and I'm hoping that having everything in one place will make it easier to route issues to the right place using labels/teams (setting this up with @zol). We've considered Github discussions as a Discord alternative, but unfortunately they don't support labels, so we're going to shut them down.

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

Successfully merging this pull request may close these issues.

None yet

6 participants