From c285bd9c9e09694f536e9c7e7f4a9f5050cb06d6 Mon Sep 17 00:00:00 2001 From: Gosha Arinich Date: Sat, 17 Sep 2016 22:59:07 +0300 Subject: [PATCH] Add the GitHub issue template 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. --- ISSUE_TEMPLATE.md | 32 ++++++++++++++++++++++++++++++++ 1 file changed, 32 insertions(+) create mode 100644 ISSUE_TEMPLATE.md diff --git a/ISSUE_TEMPLATE.md b/ISSUE_TEMPLATE.md new file mode 100644 index 00000000000..75cd52a648d --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -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.