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

[core] Improve GitHub bug reproduction template #5067

Merged

Conversation

joserodolfofreitas
Copy link
Member

@joserodolfofreitas joserodolfofreitas commented May 31, 2022

Instead of adding templates for the different components, we'll suggest to fork a demo close to the user use case.

@joserodolfofreitas joserodolfofreitas added core Infrastructure work going on behind the scenes dx Related to developers' experience labels May 31, 2022
@joserodolfofreitas joserodolfofreitas requested a review from a team May 31, 2022 19:04
@mui-bot
Copy link

mui-bot commented May 31, 2022

These are the results for the performance tests:

Test case Unit Min Max Median Mean σ
Filter 100k rows ms 277.9 562.4 467 425.18 103.094
Sort 100k rows ms 530.1 1,004.1 785.6 820.16 160.714
Select 100k rows ms 156.9 228.1 207.5 201.08 23.626
Deselect 100k rows ms 129 225.4 172.6 173.9 34.15

Generated by 🚫 dangerJS against 8fcc7f5

@joserodolfofreitas joserodolfofreitas changed the title Update github template Update github bug template May 31, 2022
Copy link
Member

@alexfauquette alexfauquette left a comment

Choose a reason for hiding this comment

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

Sounds more scalable with the number of components 👍

Copy link
Member

@flaviendelangle flaviendelangle left a comment

Choose a reason for hiding this comment

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

I would suggest to propose both options in the template.

The Codesandbox template is a link, people do not have to look for the codesandbox button on the doc (which can be non-trivial to find). So for a basic example, I think it's easier.

@oliviertassinari oliviertassinari changed the title Update github bug template [core] Improve GitHub bug reproduction template Jun 3, 2022
Copy link
Member

@flaviendelangle flaviendelangle left a comment

Choose a reason for hiding this comment

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

Great !

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.

Two thoughts:

.github/ISSUE_TEMPLATE/1.bug.yml Outdated Show resolved Hide resolved
.github/ISSUE_TEMPLATE/1.bug.yml Outdated Show resolved Hide resolved
@github-actions github-actions bot added the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 1, 2022
@github-actions
Copy link

github-actions bot commented Jul 1, 2022

This pull request has conflicts, please resolve those before we can evaluate the pull request.

@github-actions github-actions bot removed the PR: out-of-date The pull request has merge conflicts and can't be merged label Jul 1, 2022
@joserodolfofreitas joserodolfofreitas merged commit 8205d65 into mui:master Jul 9, 2022
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.

+1 for this direction, a few notes, we might want to do a follow-up PR:

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.

@@ -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

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.

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

joserodolfofreitas added a commit to joserodolfofreitas/mui-x that referenced this pull request Jul 15, 2022
Instead of adding templates for the different components, we'll suggest to fork a demo close to the user use case.
alexfauquette pushed a commit to alexfauquette/mui-x that referenced this pull request Aug 26, 2022
Instead of adding templates for the different components, we'll suggest to fork a demo close to the user use case.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core Infrastructure work going on behind the scenes dx Related to developers' experience
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants