Skip to content

Commit d468a80

Browse files
gaearongaearon
authored
Update issue & PR templates (facebook#2618)
* New issue template * Update PULL_REQUEST_TEMPLATE.md * Update ISSUE_TEMPLATE.md
1 parent 70e36f0 commit d468a80

File tree

2 files changed

+116
-32
lines changed

2 files changed

+116
-32
lines changed

‎.github/ISSUE_TEMPLATE.md

+115-30
Original file line numberDiff line numberDiff line change
@@ -1,59 +1,144 @@
1-
If you are reporting a bug, please fill in below. Otherwise feel free to remove this template entirely.
1+
<!--
2+
PLEASE DON'T DELETE THIS TEMPLATE UNTIL YOU HAVE READ THE FIRST SECTION.
3+
-->
24

3-
### Can you reproduce the problem with npm 4.x?
5+
### Is this a bug report?
6+
7+
(write your answer here)
8+
9+
<!--
10+
If you answered "Yes":
11+
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.
15+
16+
If you answered "No":
17+
18+
If this is a question or a discussion, you may delete this template and write in a free form.
19+
Note that we don't provide help for webpack questions after ejecting.
20+
You can find webpack docs at https://webpack.js.org/.
421
5-
Many errors, especially related to "missing modules", are due to npm bugs.
22+
Now let's get started!
23+
-->
624

7-
Try to update npm to 4.x first:
25+
### Can you reproduce the problem with npm 4.x?
26+
27+
<!--
28+
Many errors, especially related to "missing modules", are due to npm bugs.
29+
Which version of npm are you running? You can find out by checking:
830
9-
```
10-
npm install -g npm@4
31+
npm -v
1132
12-
cd your_project_directory
13-
rm -rf node_modules
14-
npm install
15-
```
33+
If it's not starting with 4, try to install npm 4.x:
1634
17-
**This is especially important if `npm -v` gives you 5 because npm 5 is [known to have many issues](https://github.com/npm/npm/issues/16991).**
35+
npm install -g npm@4
36+
cd your_project_directory
37+
rm -rf node_modules
38+
npm cache clear
39+
npm install
1840
19-
Then try to reproduce the issue again.
41+
Then try to reproduce the issue again.
42+
Can you still reproduce it?
2043
21-
Can you still reproduce it?
44+
Note: Please try this even if you are using Yarn. Yarn also has bugs.
45+
-->
2246

23-
### Description
47+
(Write your answer here.)
2448

25-
What are you reporting?
49+
### Have you read the Troubleshooting section and searched the User Guide?
2650

27-
### Expected behavior
51+
<!--
52+
There are a few common documented problems, such as watcher not detecting changes.
53+
They are described in the Troubleshooting section of the User Guide:
2854
29-
Tell us what you think should happen.
55+
https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting
3056
31-
### Actual behavior
57+
Have you read that section, and have you searched the User Guide for symptoms of your problem?
58+
Please write the answer below:
59+
-->
3260

33-
Tell us what actually happens.
61+
(Write your answer here.)
3462

3563
### Environment
3664

37-
Run these commands in the project folder and fill in their results:
65+
<!--
66+
Please fill in all the relevant fields by running these commands in terminal.
67+
-->
3868

39-
1. `npm ls react-scripts` (if you haven’t ejected):
40-
2. `node -v`:
41-
3. `npm -v`:
69+
1. `node -v`:
70+
2. `npm -v`:
71+
4. `yarn --version` (if you use Yarn):
72+
3. `npm ls react-scripts` (if you haven’t ejected):
4273

4374
Then, specify:
4475

4576
1. Operating system:
46-
2. Browser and version:
77+
2. Browser and version (if relevant):
78+
79+
### Steps to Reproduce
80+
81+
<!--
82+
How would you describe your issue to someone who doesn’t know you or your project?
83+
Try to write a sequence of steps that anybody can repeat to see the issue.
84+
-->
85+
86+
(Write your steps here:)
87+
88+
1.
89+
2.
90+
3.
91+
92+
### Expected Behavior
93+
94+
<!--
95+
How did you expect the tool to behave?
96+
It’s fine if you’re not sure your understanding is correct.
97+
Just write down what you thought would happen.
98+
-->
99+
100+
(Write what you thought would happen.)
101+
102+
### Actual Behavior
103+
104+
<!--
105+
Did something go wrong?
106+
Is something broken, or not behaving as you expected?
107+
Describe this section in detail, and attach screenshots if possible.
108+
-->
109+
110+
(Write what happened. Add screenshots!)
47111

48112
### Reproducible Demo
49113

50-
Please take the time to create a new app that reproduces the issue.
114+
<!--
115+
Please share a project that reproduces the issue.
116+
There are two ways to do it:
117+
118+
* Create a new app and try to reproduce the issue in it.
119+
This is useful if you roughly know where the problem is, or can’t share the real code.
120+
121+
* Or, copy your app and remove things until you’re left with the minimal reproducible demo.
122+
This is useful for finding the root cause. You may then optionally create a new project.
123+
124+
This is a good guide to creating bug demos: https://stackoverflow.com/help/mcve
125+
Once you’re done, push the project to GitHub and paste the link to it below:
126+
-->
127+
128+
(Paste the link to an example project and exact instructions to reproduce the issue.)
129+
130+
<!--
131+
What happens if you skip this step?
51132
52-
Alternatively, you could copy your app that experiences the problem and start removing things until you’re left with the minimal reproducible demo.
133+
Someone will read your bug report, and maybe will be able to help you,
134+
but it’s unlikely that it will get much attention from the team. Eventually,
135+
the issue will likely get closed in favor of issues that have reproducible demos.
53136
54-
(Accidentally, you might get to the root of your problem during that process.)
137+
Please remember that:
55138
56-
Push to GitHub and paste the link here.
139+
* Issues without reproducible demos have a very low priority.
140+
* The person fixing the bug would have to do that anyway. Please be respectful of their time.
141+
* You might figure out the issues yourself as you work on extracting it.
57142
58-
By doing this, you're helping the Create React App contributors a big time!
59-
Demonstrable issues gets fixed faster.
143+
Thanks for helping us help you!
144+
-->

‎.github/PULL_REQUEST_TEMPLATE.md

+1-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,7 @@
11
<!--
22
Thank you for sending the PR!
3-
If you changed any code, there are just two more things to do:
43
5-
* Provide us with clear instructions on how you verified your changes work. Bonus points for screenshots!
4+
If you changed any code, please provide us with clear instructions on how you verified your changes work. Bonus points for screenshots!
65
76
Happy contributing!
87
-->

0 commit comments

Comments
 (0)