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
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 3 additions & 5 deletions .github/ISSUE_TEMPLATE/1.bug.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,13 +29,11 @@ about: Create a bug report for Material-UI.
Provide a link to a live example (you can use codesandbox.io) and an unambiguous set of steps to reproduce this bug.
Include code to reproduce, if relevant (which it most likely is).

This codesandbox.io template _may_ be a good starting point:
https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/create-react-app
You should use the official codesandbox template as a starting point: https://material-ui.com/r/issue-template

If you're using typescript a better starting point would be
https://codesandbox.io/s/github/mui-org/material-ui/tree/master/examples/create-react-app-with-typescript
If you have an issue concerning TypeScript please start from this TypeScript playground: https://material-ui.com/r/ts-issue-template

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.

-->

Steps:
Expand Down
3 changes: 2 additions & 1 deletion docs/cdn/_redirects
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ https://material-ui.dev/* https://material-ui.com/:splat 301!
/r/caveat-with-refs-guide /guides/composition/#caveat-with-refs 302
/r/pseudo-classes-guide /customization/components/#pseudo-classes 302
/r/input-component-ref-interface /components/text-fields/#integration-with-3rd-party-input-libraries 302

/r/issue-template https://codesandbox.io/s/material-ui-issue-dh2yh
/r/ts-issue-template https://www.typescriptlang.org/play/#code/JYWwDg9gTgLgBAKjgQwM5wEoFNkGN4BmUEIcA5FDvmQNwBQokscA3nXHAPSdwwAWWOLhKQAdllEx0ATwgBXOHNRYAJnQC+cIiXIABEMhhYowZABsAtHOCdhlMnToE5o-MAii4AESwgIACgBKVnYuHgBNeSghCBUsDSA 302
# To remove at some point (2021).

/css-in-js/* /styles/:splat 301
Expand Down