Skip to content

Commit

Permalink
Add the GitHub issue template (#668)
Browse files Browse the repository at this point in the history
Collecting all the relevant details early on means less back and forth
between the poster and project contributors. Asking to create a small
reproducible demo means less time wasted trying to repro the bug.

Brunch has been doing this for a while and it has really helped.
There are people who deleted the template and went free-form in their
bug reports but for the most part, people have actually been filling
that in:
https://github.com/brunch/brunch/issues?q=is%3Aissue+is%3Aclosed

A lesser percentage of the people were creating the demos, but a few
definitely were. The details, and the demos especially, led to faster
resolution times, which a win for everyone.
  • Loading branch information
goshacmd authored and gaearon committed Sep 17, 2016
1 parent feae8f0 commit 6bdd335
Showing 1 changed file with 32 additions and 0 deletions.
32 changes: 32 additions & 0 deletions ISSUE_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,32 @@
If you are reporting a bug, please fill in below. Otherwise feel to remove this template entirely.

### Description

What are you reporting?

### Expected behavior

Tell us what you think should happen

### Actual behavior

Tell us what actually happens

### Environment

1. `create-react-app`: version
2. Node: version
3. NPM: version
4. Operating system:
5. Browser & version:

### Reproducible demo

Please take the time to create a new CRA app that reproduces the issue.
Alternatively, you could copy your app that experiences the problem and start removing things until you're left with the minimal reproducible demo.
(Accidentially, you might get to the root of your problem during that process.)

Push to GitHub and paste the link here.

By doing this, you're helping the CRA contributors a big time!
Demonstrable issues gets fixed faster.

0 comments on commit 6bdd335

Please sign in to comment.