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

[core] Update bug template with generic instruction #33153

Merged
merged 3 commits into from
Jun 20, 2022

Conversation

joserodolfofreitas
Copy link
Member

Summary

  • Adds a recommendation to browse the documentation and fork an example.
  • Adds an image to link on the template explaining how users can use the examples.

Motivation

We started the discussion on improving our templates for bug reproduction at the MUI X repo.
@oliviertassinari suggested to bring the discussion to MUI Core, since we face here a closer problem with Joy, Base and etc.

The Problem

How can we help the users to quickly start a live reproduction demo?

Originally the problem was raised because our bug templates were all based on the x-data-grid and x-data-grid-pro and we realized we'd need to update them as we released the x-date-pickers and the Premium plan.

Other notes

  • On X we also plan to edit the basic template to have all MUI X packages already installed.
    Perhaps it makes sense to update the templates on MUI Core too.

@joserodolfofreitas joserodolfofreitas changed the title Recommend start the reproduction case from an example Update Bug template with generic instruction Jun 14, 2022
@joserodolfofreitas joserodolfofreitas changed the title Update Bug template with generic instruction Update bug template with generic instruction Jun 14, 2022
@joserodolfofreitas joserodolfofreitas added the core Infrastructure work going on behind the scenes label Jun 14, 2022
@mui-bot
Copy link

mui-bot commented Jun 14, 2022

No bundle size changes

Generated by 🚫 dangerJS against 1853dcb

Copy link
Member

@oliviertassinari oliviertassinari left a comment

Choose a reason for hiding this comment

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

Looks good

.github/ISSUE_TEMPLATE/1.bug.yml Outdated Show resolved Hide resolved
Copy link
Contributor

@samuelsycamore samuelsycamore left a comment

Choose a reason for hiding this comment

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

Text looks good!

@oliviertassinari oliviertassinari requested a review from a team June 15, 2022 22:08
joserodolfofreitas and others added 2 commits June 16, 2022 14:02
Co-authored-by: Olivier Tassinari <olivier.tassinari@gmail.com>
Co-authored-by: Michał Dudak <michal.dudak@gmail.com>
@hbjORbj hbjORbj changed the title Update bug template with generic instruction [core] Update bug template with generic instruction Jun 20, 2022
@hbjORbj hbjORbj merged commit 179f1fd into mui:master Jun 20, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

6 participants