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.

Sign up for GitHub

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

[code-infra] Simplify bug reproduction #40833

Merged
merged 2 commits into from
Feb 3, 2024
Merged

[code-infra] Simplify bug reproduction #40833

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37410d3
[code-infra] Simplify bug reproduction
oliviertassinari Jan 28, 2024
13057aa
stackblitz
oliviertassinari Jan 28, 2024
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
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/1.bug.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)

Expand Down
11 changes: 11 additions & 0 deletions docs/data/base/getting-started/support/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@
- 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.

Check warning on line 26 in docs/data/base/getting-started/support/support.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/data/base/getting-started/support/support.md", "range": {"start": {"line": 26, "column": 1}}}, "severity": "WARNING"}
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.
Expand Down
11 changes: 11 additions & 0 deletions docs/data/joy/getting-started/support/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@
- 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.

Check warning on line 26 in docs/data/joy/getting-started/support/support.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/data/joy/getting-started/support/support.md", "range": {"start": {"line": 26, "column": 1}}}, "severity": "WARNING"}
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.
Expand Down
11 changes: 11 additions & 0 deletions docs/data/material/getting-started/support/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@
- 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.

Check warning on line 26 in docs/data/material/getting-started/support/support.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/data/material/getting-started/support/support.md", "range": {"start": {"line": 26, "column": 1}}}, "severity": "WARNING"}
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.
Expand Down
11 changes: 11 additions & 0 deletions docs/data/system/getting-started/support/support.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,17 @@
- 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.

Check warning on line 26 in docs/data/system/getting-started/support/support.md

View workflow job for this annotation

GitHub Actions / runner / vale 

[vale] reported by reviewdog 🐶
[Google.We] Try to avoid using first-person plural like 'We'.

Raw Output:
{"message": "[Google.We] Try to avoid using first-person plural like 'We'.", "location": {"path": "docs/data/system/getting-started/support/support.md", "range": {"start": {"line": 26, "column": 1}}}, "severity": "WARNING"}
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.
Expand Down
6 changes: 3 additions & 3 deletions docs/public/_redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Binary file added docs/public/static/docs-infra/forking-an-example.png
View file
Open in desktop
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed docs/public/static/docs/forking-an-example.png
View file
Open in desktop
Binary file not shown.
Loading