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

Jump to bottom

Provide base Codesandboxes in issue templates #19276

Closed
1 task done
lcswillems opened this issue Jan 17, 2020 · 4 comments
Closed
1 task done

Provide base Codesandboxes in issue templates #19276

lcswillems opened this issue Jan 17, 2020 · 4 comments
Assignees
@eps1lon
Labels
docs Improvements or additions to the documentation

Comments

@lcswillems
Copy link
Contributor

lcswillems commented Jan 17, 2020 •
edited
Loading

  • I have searched the issues of this repository and believe that this is not a duplicate.

Summary

Providing two base Codesandboxes (one for javascript, one for Typescript) in the issue templates. For example, Fabric.js and Prosemirror already do it and it makes submitting a bug a pleasing process.

Motivation

Everytime I wanted to report a bug in the library I had to create a Codesandbox from scratch. This is problematic because:

  • it is not trivial to correctly setup a base Codesandbox, i.e. it takes time and this is the least thing you want to do when you are angry because you discovered a bug in the library. Moreover, for reporting TypeScript bugs, I can't even figure out how to setup a base Codesandbox
  • everybody that wants to report a bug has to do the exact same thing again and again. This is a big waste of time

If you provide such base codesandboxes, people will be much more inclined to attach repros to their bug reports, but also (and this is the more important), will be much more inclined to submit the bugs they encounter.
@oliviertassinari oliviertassinari added the support: question Community support but can be turned into an improvement label Jan 17, 2020
@oliviertassinari
Copy link
Member

oliviertassinari commented Jan 17, 2020 •
edited
Loading

@lcswillems You have two options:

  1. Follow the 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

  1. Or create a TypeScript sandbox from one of the demos:
    Capture d’écran 2020-01-17 à 13 43 32

@eps1lon
Copy link
Member

eps1lon commented Jan 17, 2020

I'll reopen to have a dedicated issue for codesandbox templates. These were added a few weeks ago. I also want to make the wording stronger for the linked sandboxes. These are! good starting points. Not just "might".

@eps1lon eps1lon self-assigned this Jan 17, 2020
@eps1lon eps1lon reopened this Jan 17, 2020
@oliviertassinari oliviertassinari removed the support: question Community support but can be turned into an improvement label Jan 17, 2020
@lcswillems
Copy link
Contributor Author

Sorry! I missed the codesandbox in the template... probably because they weren't there the first time I opened the issue and that, next times, I removed comments without reading them again.

But this is great to have created this base codesandboxes!

@oliviertassinari oliviertassinari added the docs Improvements or additions to the documentation label Jan 17, 2020
@eps1lon
Copy link
Member

eps1lon commented Feb 13, 2020

Was closed in #19501

@eps1lon eps1lon closed this as completed Feb 13, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@eps1lon eps1lon

Labels
docs Improvements or additions to the documentation
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@oliviertassinari @lcswillems @eps1lon