Skip to content

Commit 425739e

Browse files
committed
Move the CRA/npm instructions to CONTRIBUTING file
1 parent a7d8cb1 commit 425739e

File tree

2 files changed

+50
-44
lines changed

2 files changed

+50
-44
lines changed

CONTRIBUTING.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
# Thank you for choosing to contribute!
2+
3+
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). If you wish to contribute, please report any issues or suggestions, or send bug fixes as pull requests.
4+
5+
## Available Scripts
6+
7+
In the project directory, you can run:
8+
9+
### `npm start`
10+
11+
Runs the app in the development mode.\
12+
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
13+
14+
The page will reload if you make edits.\
15+
You will also see any lint errors in the console.
16+
17+
### `npm test`
18+
19+
Launches the test runner in the interactive watch mode.\
20+
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
21+
22+
### `npm run build`
23+
24+
Builds the app for production to the `build` folder.\
25+
It correctly bundles React in production mode and optimizes the build for the best performance.
26+
27+
The build is minified and the filenames include the hashes.\
28+
Your app is ready to be deployed!
29+
30+
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
31+
32+
### `npm run eject`
33+
34+
> [!NOTE]
35+
> Please don't use this command. The information is provided for educational purposes only.
36+
37+
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
38+
39+
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
40+
41+
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
42+
43+
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
44+
45+
## Learn More
46+
47+
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
48+
49+
To learn React, check out the [React documentation](https://reactjs.org/).

README.md

Lines changed: 1 addition & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -4,47 +4,4 @@ There are many position size calculators in the internet but they are complex fo
44

55
So I decided to create one. 🙂
66

7-
This project was bootstrapped with [Create React App](https://github.com/facebook/create-react-app). If you wish to contribute, please report any issues or suggestions, or send bug fixes as pull requests.
8-
9-
## Available Scripts
10-
11-
In the project directory, you can run:
12-
13-
### `npm start`
14-
15-
Runs the app in the development mode.\
16-
Open [http://localhost:3000](http://localhost:3000) to view it in the browser.
17-
18-
The page will reload if you make edits.\
19-
You will also see any lint errors in the console.
20-
21-
### `npm test`
22-
23-
Launches the test runner in the interactive watch mode.\
24-
See the section about [running tests](https://facebook.github.io/create-react-app/docs/running-tests) for more information.
25-
26-
### `npm run build`
27-
28-
Builds the app for production to the `build` folder.\
29-
It correctly bundles React in production mode and optimizes the build for the best performance.
30-
31-
The build is minified and the filenames include the hashes.\
32-
Your app is ready to be deployed!
33-
34-
See the section about [deployment](https://facebook.github.io/create-react-app/docs/deployment) for more information.
35-
36-
### `npm run eject`
37-
38-
**Note: this is a one-way operation. Once you `eject`, you can’t go back!**
39-
40-
If you aren’t satisfied with the build tool and configuration choices, you can `eject` at any time. This command will remove the single build dependency from your project.
41-
42-
Instead, it will copy all the configuration files and the transitive dependencies (webpack, Babel, ESLint, etc) right into your project so you have full control over them. All of the commands except `eject` will still work, but they will point to the copied scripts so you can tweak them. At this point you’re on your own.
43-
44-
You don’t have to ever use `eject`. The curated feature set is suitable for small and middle deployments, and you shouldn’t feel obligated to use this feature. However we understand that this tool wouldn’t be useful if you couldn’t customize it when you are ready for it.
45-
46-
## Learn More
47-
48-
You can learn more in the [Create React App documentation](https://facebook.github.io/create-react-app/docs/getting-started).
49-
50-
To learn React, check out the [React documentation](https://reactjs.org/).
7+
If you wish to [contribute](CONTRIBUTING.md), please report any issues or suggestions, or send bug fixes as pull requests.

0 commit comments

Comments
 (0)