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

[core] Improve GitHub bug reproduction template #5067

Merged
merged 11 commits into from
Jul 9, 2022
Merged

[core] Improve GitHub bug reproduction template #5067

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
11 commits
Select commit Hold shift + click to select a range
1ed6a51
Remove base data grid codesandbox references and suggest starting fro…
joserodolfofreitas May 31, 2022
58e83a5
Small fix
joserodolfofreitas May 31, 2022
524f527
Add placeholder for the reproduction case link
joserodolfofreitas May 31, 2022
829f1e6
Add a basic template and an image showing how to fork an example
joserodolfofreitas Jun 13, 2022
cff8d84
Add img
joserodolfofreitas Jun 13, 2022
82f982c
Update image
joserodolfofreitas Jun 13, 2022
815e7c6
Add missing comma
joserodolfofreitas Jun 13, 2022
98aed63
Remove forking-example img from x repo
joserodolfofreitas Jun 29, 2022
167cd6d
Update img URL
joserodolfofreitas Jun 29, 2022
6bf8733
Simplifying the message
joserodolfofreitas Jun 29, 2022
8fcc7f5
Add redirect to x-issue-template
joserodolfofreitas Jul 1, 2022
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
12 changes: 6 additions & 6 deletions .github/ISSUE_TEMPLATE/1.bug.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,17 +34,17 @@ body:
attributes:
label: Steps to reproduce 🕹
description: |
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).
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/x/advanced-components/), and [select](https://mui.com/static/docs/forking-an-example.png) the closest example to your use case.
Copy link
Member

Choose a reason for hiding this comment

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

This link is a 301

Suggested change
As a starting point, we recommend you browse our [documentation](https://mui.com/x/advanced-components/), and [select](https://mui.com/static/docs/forking-an-example.png) the closest example to your use case.
As a starting point, we recommend you browse our [documentation](https://mui.com/x/introduction/), and [select](https://mui.com/static/docs/forking-an-example.png) the closest example to your use case.

Copy link
Member

Choose a reason for hiding this comment

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

"the documentation". We document ourselves here 😁

Suggested change
As a starting point, we recommend you browse our [documentation](https://mui.com/x/advanced-components/), and [select](https://mui.com/static/docs/forking-an-example.png) the closest example to your use case.
As a starting point, we recommend you [browse the documentation](https://mui.com/x/introduction/), and [select](https://mui.com/static/docs/forking-an-example.png) the closest example to your use case.


You can use the official codesandbox template of the [DataGrid](https://codesandbox.io/s/datagrid-v5-quick-start-54iz1) or [DataGridPro](https://codesandbox.io/s/datagridpro-v5-quick-start-5pjhc) as a starting point.

If you have an issue concerning TypeScript please start from this TypeScript playground: https://mui.com/r/ts-issue-template.
Or you can use a [basic template](https://mui.com/r/x-issue-template) to build your reproduction case.
Copy link
Member

Choose a reason for hiding this comment

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

Would it feel better without the blank line before "Or you can use"?

Screenshot 2022-07-09 at 11 45 54


Issues that we can't reproduce will be closed.
value: |
Link to live example:

Steps:

1.
2.
3.
Expand Down
1 change: 1 addition & 0 deletions docs/public/_redirects
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@
/r/x-license-eula https://mui.com/store/legal/mui-x-eula/ 302
/r/x-license-key-installation https://mui.com/x/advanced-components/#license-key-installation 302
/r/x-data-grid-no-dimensions https://mui.com/x/react-data-grid/layout/ 302
/r/x-issue-template https://codesandbox.io/s/mui-x-issue-template-uh3pm2 302
Copy link
Member

Choose a reason for hiding this comment

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

Please move the codesandbox under the MUI organization, so others can modify it later on.

Screenshot 2022-07-09 at 11 43 53

Copy link
Member

@oliviertassinari oliviertassinari Jul 9, 2022 •
edited
Loading

Choose a reason for hiding this comment

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

For example, we likely want to fix:

Screenshot 2022-07-09 at 11 46 47

so developers can start from a clean state.


# Legacy redirection
# 2021
Expand Down