Skip to content
This repository was archived by the owner on Jan 26, 2019. It is now read-only.

Commit 7d8c31b

Browse files
gaearonwmonk
authored andcommitted
Less passive-aggressive issue template
1 parent 6d87749 commit 7d8c31b

File tree

1 file changed

+31
-25
lines changed

1 file changed

+31
-25
lines changed

.github/ISSUE_TEMPLATE.md

+31-25
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
<!--
2-
PLEASE DON'T DELETE THIS TEMPLATE UNTIL YOU HAVE READ THE FIRST SECTION.
2+
PLEASE READ THE FIRST SECTION :-)
33
-->
44

55
### Is this a bug report?
@@ -8,18 +8,20 @@
88

99
<!--
1010
If you answered "Yes":
11+
12+
Please note that your issue will be fixed much faster if you spend about
13+
half an hour preparing it, including the exact reproduction steps and a demo.
14+
15+
If you're in a hurry or don't feel confident, it's fine to report bugs with
16+
less details, but this makes it less likely they'll get fixed soon.
1117
12-
We expect that it will take you about 30 minutes to produce a high-quality bug report.
13-
While this may seem like a lot, putting care into issues helps us fix them faster.
14-
For bug reports, it is REQUIRED to fill the rest of this template, or the issue will be closed.
18+
In either case, please fill as many fields below as you can.
1519
1620
If you answered "No":
1721
1822
If this is a question or a discussion, you may delete this template and write in a free form.
1923
Note that we don't provide help for webpack questions after ejecting.
2024
You can find webpack docs at https://webpack.js.org/.
21-
22-
Now scroll below!
2325
-->
2426

2527

@@ -42,25 +44,30 @@
4244
Then try to reproduce the issue again.
4345
Can you still reproduce it?
4446
45-
Note: Please try this even if you are using Yarn. Yarn also has bugs.
47+
Note: Please try this even if you are using Yarn so that we know whether it's a Yarn-only bug.
4648
-->
4749

4850
(Write your answer here.)
4951

5052

51-
### Have you read the Troubleshooting section and searched the User Guide?
53+
### Which terms did you search for in User Guide?
5254

5355
<!--
54-
There are a few common documented problems, such as watcher not detecting changes.
56+
There are a few common documented problems, such as watcher not detecting changes, or build failing.
5557
They are described in the Troubleshooting section of the User Guide:
5658
5759
https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting
5860
59-
Have you read that section, and have you searched the User Guide for symptoms of your problem?
60-
Please write the answer below:
61+
Please scan these few sections for common problems.
62+
Additionally, you can search the User Guide itself for something you're having issues with:
63+
64+
https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.me
65+
66+
If you didn't find the solution, please share which words you searched for.
67+
This helps us improve documentation for future readers who might encounter the same problem.
6168
-->
6269

63-
(Write the terms you searched for on the User Guide page.)
70+
(Write your answer here if relevant.)
6471

6572

6673
### Environment
@@ -111,16 +118,18 @@ Then, specify:
111118
<!--
112119
Did something go wrong?
113120
Is something broken, or not behaving as you expected?
114-
Describe this section in detail, and attach screenshots if possible.
121+
Please attach screenshots if possible! They are extremely helpful for diagnosing issues.
115122
-->
116123

117-
(Write what happened. Add screenshots!)
124+
(Write what happened. Please add screenshots!)
118125

119126

120127
### Reproducible Demo
121128

122129
<!--
123-
Please share a project that reproduces the issue.
130+
If you can, please share a project that reproduces the issue.
131+
This is the single most effective way to get an issue fixed soon.
132+
124133
There are two ways to do it:
125134
126135
* Create a new app and try to reproduce the issue in it.
@@ -137,16 +146,13 @@ Then, specify:
137146

138147
<!--
139148
What happens if you skip this step?
140-
141-
Someone will read your bug report, and maybe will be able to help you,
142-
but it’s unlikely that it will get much attention from the team. Eventually,
143-
the issue will likely get closed in favor of issues that have reproducible demos.
144-
145-
Please remember that:
146-
147-
* Issues without reproducible demos have a very low priority.
148-
* The person fixing the bug would have to do that anyway. Please be respectful of their time.
149-
* You might figure out the issues yourself as you work on extracting it.
149+
150+
We will try to help you, but in many cases it is impossible because crucial
151+
information is missing. In that case we'll tag an issue as having a low priority,
152+
and eventually close it if there is no clear direction.
153+
154+
We still appreciate the report though, as eventually somebody else might
155+
create a reproducible example for it.
150156
151157
Thanks for helping us help you!
152158
-->

0 commit comments

Comments
 (0)