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

[docs] Improve entry points for issue repros #19501

Merged
merged 2 commits into from
Feb 2, 2020

Conversation

eps1lon
Copy link
Member

@eps1lon eps1lon commented Jan 31, 2020

Ready for review though not mergable. ~I want to fix/improve the TypeScript playground experience first (since it doesn't support @material-ui/core/Typography yet). ~ Involves too much work. Would like to see microsoft/TypeScript-Website#206 get fixed at some point though.

Opening to get feedback about the wording.

Recommended codesandbox for repros is now a dedicated codesandbox template that is owned by the team (need your names for invite).

@eps1lon eps1lon added docs Improvements or additions to the documentation on hold There is a blocker, we need to wait labels Jan 31, 2020
@mui-pr-bot
Copy link

mui-pr-bot commented Jan 31, 2020

No bundle size changes comparing 5a2fd6a...4da57d4

Generated by 🚫 dangerJS against 4da57d4

docs/cdn/_redirects Outdated Show resolved Hide resolved
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.

  • It seems that we can use our GitHub slug for invites, does it work with "oliviertassinari"?
  • For this template: https://codesandbox.io/s/material-ui-issue-dh2yh, should we expose the ThemeProvider? Sometimes it's useful to showcase an issue with the theme, but I wonder, it's not very frequent either.
  • What're tradeoff (pros/cons) of the template vs polling the CRA example?


If YOU DO NOT take time to provide a codesandbox.io reproduction, should the COMMUNITY take time to help you?
Issues without some form of live example have a longer response time.
Copy link
Member

Choose a reason for hiding this comment

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

😆

Suggested change
Issues without some form of live example have a longer response time.
Issues without some form of live example will be ignored and closed.

Copy link
Member Author

Choose a reason for hiding this comment

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

If I'm moody, yes ;) I would introduce a "missing reproduction" label and close these if they have that label for 7 days.

Copy link
Member

Choose a reason for hiding this comment

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

What about the incomplete label, and close with this message?

The issue has been closed because it does not conform to our issue requirements.
Please provide a full reproduction test case. This would help a lot 👷 .
A live example would be perfect. This codesandbox.io template may be a good starting point. Thank you!

Copy link
Member Author

Choose a reason for hiding this comment

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

Yep and then use the issue template instead of the example.

@eps1lon
Copy link
Member Author

eps1lon commented Feb 2, 2020

What're tradeoff (pros/cons) of the template vs polling the CRA example?

Different goals: One showcases example usage, the other is a base for an issue. In one you have a sandbox where you can delete things. You shouldn't delete anything from the template.

It seems that we can use our GitHub slug for invites, does it work with "oliviertassinari"?

Invite sent.

should we expose the ThemeProvider

Not every issue uses the provider. In most issues it would be just noise.

Co-Authored-By: Kristoffer K. <[email protected]>
@eps1lon eps1lon removed the on hold There is a blocker, we need to wait label Feb 2, 2020
@eps1lon eps1lon merged commit 4a96d14 into mui:master Feb 2, 2020
@eps1lon eps1lon deleted the docs/contrib-sandbox branch February 2, 2020 23:26
EsoterikStare pushed a commit to EsoterikStare/material-ui that referenced this pull request Feb 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docs Improvements or additions to the documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants