diff --git a/.github/ISSUE_TEMPLATE/1.bug.yml b/.github/ISSUE_TEMPLATE/1.bug.yml index faf654a00f515b..e765d2527d1d06 100644 --- a/.github/ISSUE_TEMPLATE/1.bug.yml +++ b/.github/ISSUE_TEMPLATE/1.bug.yml @@ -26,7 +26,7 @@ body: description: | **⚠️ Issues that we can't reproduce can't be fixed.** - Please provide a link to a live example and an unambiguous set of steps to reproduce this bug. As a starting point, we recommend you browse our [documentation](https://mui.com/material-ui/getting-started/installation/), and [select](https://mui.com/static/docs/forking-an-example.png) the closest example to your use case. Or you can use the [official template](https://mui.com/r/issue-template) to build a reproduction case. + Please provide a link to a live example and an unambiguous set of steps to reproduce this bug. See our [documentation](https://mui.com/material-ui/getting-started/support/#bug-reproductions) on how to build a reproduction case. value: | Link to live example: (required) diff --git a/docs/data/base/getting-started/support/support.md b/docs/data/base/getting-started/support/support.md index 1d5193c4f2b38d..4281934a762db4 100644 --- a/docs/data/base/getting-started/support/support.md +++ b/docs/data/base/getting-started/support/support.md @@ -21,6 +21,17 @@ If you think you've found a bug, or you have a new feature idea: - Please don't group multiple topics in one issue. - Please don't comment "+1" on an issue. It spams the maintainers and doesn't help move the issue forward. Use GitHub reactions instead (👍). +### Bug reproductions + +We require bug reports to be accompanied by a minimal reproduction. +It significantly increases the odds of fixing the problem. +You have a few options possible to provide it: + +- You can browse the documentation, find an example close to your use case, and then open it in a live editor: + [![Forking an example](/static/docs-infra/forking-an-example.png)](/base-ui/react-button/#introduction) + +- You can use a starter React template to build a reproduction case with [JavaScript](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react) or [TypeScript](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react-ts). + ## Stack Overflow We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Base UI community as well as Base UI maintainers. diff --git a/docs/data/joy/getting-started/support/support.md b/docs/data/joy/getting-started/support/support.md index 5e3932692e1117..8671089069ee8c 100644 --- a/docs/data/joy/getting-started/support/support.md +++ b/docs/data/joy/getting-started/support/support.md @@ -21,6 +21,17 @@ If you think you've found a bug, or you have a new feature idea: - Please don't group multiple topics in one issue. - Please don't comment "+1" on an issue. It spams the maintainers and doesn't help move the issue forward. Use GitHub reactions instead (👍). +### Bug reproductions + +We require bug reports to be accompanied by a minimal reproduction. +It significantly increases the odds of fixing the problem. +You have a few options possible to provide it: + +- You can browse the documentation, find an example close to your use case, and then open it in a live editor: + [![Forking an example](/static/docs-infra/forking-an-example.png)](/joy-ui/react-button/#basics) + +- You can use a starter React template to build a reproduction case with [JavaScript](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react) or [TypeScript](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react-ts). + ## Stack Overflow We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Joy UI community as well as Joy UI maintainers. diff --git a/docs/data/material/getting-started/support/support.md b/docs/data/material/getting-started/support/support.md index aabb3e6614e9f3..ab8f926563215a 100644 --- a/docs/data/material/getting-started/support/support.md +++ b/docs/data/material/getting-started/support/support.md @@ -21,6 +21,17 @@ If you think you've found a bug, or you have a new feature idea: - Please don't group multiple topics in one issue. - Please don't comment "+1" on an issue. It spams the maintainers and doesn't help move the issue forward. Use GitHub reactions instead (👍). +### Bug reproductions + +We require bug reports to be accompanied by a minimal reproduction. +It significantly increases the odds of fixing the problem. +You have a few options possible to provide it: + +- You can browse the documentation, find an example close to your use case, and then open it in a live editor: + [![Forking an example](/static/docs-infra/forking-an-example.png)](/material-ui/react-button/#basic-button) + +- You can use a starter React template to build a reproduction case with [JavaScript](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react) or [TypeScript](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react-ts). + ## Stack Overflow We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the Material UI community as well as Material UI maintainers. diff --git a/docs/data/system/getting-started/support/support.md b/docs/data/system/getting-started/support/support.md index 03449997609e5d..b858ed20c173b8 100644 --- a/docs/data/system/getting-started/support/support.md +++ b/docs/data/system/getting-started/support/support.md @@ -21,6 +21,17 @@ If you think you've found a bug, or you have a new feature idea: - Please don't group multiple topics in one issue. - Please don't comment "+1" on an issue. It spams the maintainers and doesn't help move the issue forward. Use GitHub reactions instead (👍). +### Bug reproductions + +We require bug reports to be accompanied by a minimal reproduction. +It significantly increases the odds of fixing the problem. +You have a few options possible to provide it: + +- You can browse the documentation, find an example close to your use case, and then open it in a live editor: + [![Forking an example](/static/docs-infra/forking-an-example.png)](/system/borders/#additive) + +- You can use a starter React template to build a reproduction case with [JavaScript](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react) or [TypeScript](https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react-ts). + ## Stack Overflow We use Stack Overflow for how-to questions. Answers are crowdsourced from expert developers in the MUI System community as well as MUI System maintainers. diff --git a/docs/public/_redirects b/docs/public/_redirects index 8434c880d8d00c..37ff08871dc40a 100644 --- a/docs/public/_redirects +++ b/docs/public/_redirects @@ -16,9 +16,9 @@ /r/pseudo-classes-guide /material-ui/customization/how-to-customize/#state-classes 302 /r/state-classes-guide /material-ui/customization/how-to-customize/#state-classes 302 /r/input-component-ref-interface /material-ui/react-text-field/#integration-with-3rd-party-input-libraries 302 -/r/issue-template https://codesandbox.io/p/sandbox/material-ui-issue-latest-s2dsx 302 -/r/issue-template-next https://codesandbox.io/p/sandbox/material-ui-issue-next-o7xkt 302 -/r/issue-template-latest https://codesandbox.io/p/sandbox/material-ui-issue-latest-s2dsx 302 +/r/issue-template https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react-ts 302 +/r/issue-template-next https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react-ts 302 +/r/issue-template-latest https://stackblitz.com/fork/github/stackblitz/starters/tree/main/react-ts 302 /r/ts-issue-template https://www.typescriptlang.org/play?#code/JYWwDg9gTgLgBAKjgQwM5wEoFNkGN4BmUEIcA5FDvmQNwBQokscA3nXHAPSdwwAWWOLhKQAdllEx0ATwgBXOHNRYAJnQC+cIiXIABEHOCcQyGFijBkAGzJ06BOaPzAIouABEsICAAoAlKzsXDwAmvJQQhAqWBpAA 302 /r/custom-component-variants /material-ui/customization/how-to-customize/#adding-new-component-variants 302 /r/migration-v4 /material-ui/migration/migration-v4/ 302 diff --git a/docs/public/static/docs-infra/forking-an-example.png b/docs/public/static/docs-infra/forking-an-example.png new file mode 100644 index 00000000000000..d1a46bb379590b Binary files /dev/null and b/docs/public/static/docs-infra/forking-an-example.png differ diff --git a/docs/public/static/docs/forking-an-example.png b/docs/public/static/docs/forking-an-example.png deleted file mode 100644 index 50b741095147ef..00000000000000 Binary files a/docs/public/static/docs/forking-an-example.png and /dev/null differ