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

Convert issue templates to forms #19370

Merged
merged 2 commits into from
Oct 18, 2022
Merged

Convert issue templates to forms #19370

merged 2 commits into from
Oct 18, 2022

Conversation

mrhappyma
Copy link
Contributor

I tried to copy these from the existing templates as much as possible.

@yannbf yannbf added the maintenance User-facing maintenance tasks label Oct 10, 2022
@yannbf
Copy link
Member

yannbf commented Oct 10, 2022

Hey @mrhappyma Thank you so much for your contribution! Unfortunately we can't see the end result unless we merge this PR, so I'll set this up somewhere else and share it here, so that we can discuss further about this.

Thank you once again!

@yannbf yannbf self-assigned this Oct 10, 2022
@mrhappyma
Copy link
Contributor Author

@yannbf I do have issues enabled on my fork! You can try creating one there to see what it looks like: https://github.com/mrhappyma/storybook/issues/new/choose

@yannbf
Copy link
Member

yannbf commented Oct 11, 2022

Thank you @mrhappyma I'll share the screenshots here so we can discuss this further with the team!

Here's the view for filing a bug report:
image

Once you click on any field, it becomes a markdown-like editor
image

And here's the one for filing a feature request:
image

I think this change is great but the current state of the form could be changed, maybe this is our chance to improve this template as it hasn't been touched for quite some time. I'd love to hear your thoughts @kylegach @winkerVSbecks @jonniebigodes @ShaunLloyd @IanVS @storybookjs/core

@yannbf
Copy link
Member

yannbf commented Oct 11, 2022

I really like the form created for storybook-addon-designs

image

We could use something that makes it easier for users to specify configurations such as renderer, framework, builder, Storybook version, etc.

@JReinhold
Copy link
Contributor

Overall I also think this looks really good.

We could use something that makes it easier for users to specify configurations such as renderer, framework, builder, Storybook version, etc.

Agree. The challenge here is that we'll end up with a lot of options, and we don't want a dropdown because you'd want to be able to select multiple, so we'd have a lot of checkboxes. But maybe that's okay. Two open questions:

  • Do we need to make a distinction between officially and community supported renderers/frameworks?
  • We have a mismatch in terms. What we call "renderers" the industry calls "frameworks"*, and what we call "frameworks" the industry calls "metaframeworks". Do we need to handle this? Maybe if the user has options anyway it won't be that confusing. (we were bound to run into this term-mismatch eventually)

* except we also have an HTML renderer which no one would call a framework.

I also really like the Importance/Severity from the SvelteKit repo. Makes it easier to triage even though users tend to overestimate this.

Bug reports:
image

Feature requests:
image

@winkerVSbecks
Copy link
Contributor

@JReinhold would be nice to add a field for reproduction i.e., not just steps but an actual repo/gist

@IanVS
Copy link
Member

IanVS commented Oct 11, 2022

Another great repo that I like to use for inspiration is Astro: https://github.com/withastro/astro/issues/new/choose

@ndelangen
Copy link
Member

Are we moving this forward? I think this is an improvement.

Copy link
Member

@IanVS IanVS left a comment

Choose a reason for hiding this comment

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

I agree. Maybe merging this as-is would be a good first step, since it keeps the same basic info as we have currently, and then we can make another PR with further improvements and refinements?

@ndelangen ndelangen merged commit 7e0c8f8 into storybookjs:next Oct 18, 2022
@mrhappyma
Copy link
Contributor Author

🎉 thanks!

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.

6 participants