Skip to content

Commit 294d2ba

Browse files
committed
modify github template
1 parent 66a857e commit 294d2ba

File tree

1 file changed

+36
-28
lines changed

1 file changed

+36
-28
lines changed

.github/ISSUE_TEMPLATE.md

Lines changed: 36 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -24,47 +24,56 @@
2424
You can find webpack docs at https://webpack.js.org/.
2525
-->
2626

27-
28-
### Can you also reproduce the problem with npm 4.x?
27+
### Did you try recovering your dependencies?
2928

3029
<!--
31-
Many errors, especially related to "missing modules", are due to npm bugs.
32-
Which version of npm are you running? You can find out by checking:
33-
34-
npm -v
30+
Your module tree might be corrupted, and that might be causing the issues.
31+
Let's try to recover it. First, delete these files and folders in your project:
3532
36-
If it is 5.x, please be aware that it has more than 50 known bugs, and
37-
is not guaranteed to work with Create React App.
33+
* node_modules
34+
* package-lock.json
35+
* yarn.lock
3836
39-
If it's not starting with 4, try to install npm 4.x:
37+
Then you need to decide which package manager you prefer to use.
38+
We support both npm (https://npmjs.com) and yarn (http://yarnpkg.com/).
39+
However, **they can't be used together in one project** so you need to pick one.
40+
41+
If you decided to use npm, run this in your project directory:
4042
41-
npm install -g npm@4
42-
cd your_project_directory
43-
rm -rf node_modules
44-
npm cache clear
43+
npm install -g npm@latest
4544
npm install
4645
47-
Then try to reproduce the issue again.
48-
Can you still reproduce it?
46+
This should fix your project.
47+
48+
If you decided to use yarn, update it first (https://yarnpkg.com/en/docs/install).
49+
Then run in your project directory:
50+
51+
yarn
4952
50-
Note: Please try this even if you are using Yarn so that we know whether it's a Yarn-only bug.
53+
This should fix your project.
54+
55+
Importantly, **if you decided to use yarn, you should never run `npm install` in the project**.
56+
For example, yarn users should run `yarn add <library>` instead of `npm install <library>`.
57+
Otherwise your project will break again.
58+
59+
Have you done all these steps and still see the issue?
60+
Please paste the output of `npm --version` and/or `yarn --version` to confirm.
5161
-->
5262

5363
(Write your answer here.)
5464

55-
5665
### Which terms did you search for in User Guide?
5766

5867
<!--
5968
There are a few common documented problems, such as watcher not detecting changes, or build failing.
6069
They are described in the Troubleshooting section of the User Guide:
6170
62-
https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting
71+
https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#troubleshooting
6372
6473
Please scan these few sections for common problems.
6574
Additionally, you can search the User Guide itself for something you're having issues with:
6675
67-
https://github.com/facebookincubator/create-react-app/blob/master/packages/react-scripts/template/README.md
76+
https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md
6877
6978
If you didn't find the solution, please share which words you searched for.
7079
This helps us improve documentation for future readers who might encounter the same problem.
@@ -76,19 +85,18 @@
7685
### Environment
7786

7887
<!--
79-
Please fill in all the relevant fields by running these commands in terminal.
80-
-->
88+
To help identify if a problem is specific to a platform, browser, or module version, information about your environment is required.
89+
This enables the maintainers quickly reproduce the issue and give feedback.
8190
82-
1. `node -v`:
83-
2. `npm -v`:
84-
3. `yarn --version` (if you use Yarn):
85-
4. `npm ls react-scripts` (if you haven’t ejected):
91+
Run the following command in your React app's folder in terminal.
92+
Note: The result is copied to your clipboard directly.
8693
87-
Then, specify:
94+
`npx create-react-app --info`
8895
89-
1. Operating system:
90-
2. Browser and version (if relevant):
96+
Paste the output of the command in the section below.
97+
-->
9198

99+
(paste the output of the command here)
92100

93101
### Steps to Reproduce
94102

0 commit comments

Comments
 (0)