Skip to content

Commit 0b9c65f

Browse files
anilreddykattaTimer
authored andcommitted
Add folder structure docs for new contributors (#1991)
* Adding folder structure to help people navigate through project. It helps in resolving issues by providing brief description of each package and its purpose * Removing unnecessary packages from Folder structure heading * Update CONTRIBUTING.md
1 parent ef86877 commit 0b9c65f

File tree

1 file changed

+30
-0
lines changed

1 file changed

+30
-0
lines changed

CONTRIBUTING.md

+30
Original file line numberDiff line numberDiff line change
@@ -41,6 +41,36 @@ Please **ask first** if somebody else is already working on this or the core dev
4141

4242
Please also provide a **test plan**, i.e. specify how you verified that your addition works.
4343

44+
## Folder Structure of Create React App
45+
`create-react-app` is a monorepo, meaning it is divided into independent sub-packages.<br>
46+
These packages can be found in the [`packages/`](https://github.com/facebookincubator/create-react-app/tree/master/packages) directory.
47+
48+
### Overview of directory structure
49+
```
50+
packages/
51+
babel-preset-react-app/
52+
create-react-app/
53+
eslint-config-react-app/
54+
react-dev-utils/
55+
react-scripts/
56+
```
57+
### Package Descriptions
58+
#### [babel-preset-react-app](https://github.com/facebookincubator/create-react-app/tree/master/packages/babel-preset-react-app)
59+
This package is a babel preset intended to be used with `react-scripts`.<br>
60+
It targets platforms that React is designed to support (IE 9+) and enables experimental features used heavily at Facebook.<br>
61+
This package is enabled by default for all `create-react-app` scaffolded applications.
62+
#### [create-react-app](https://github.com/facebookincubator/create-react-app/tree/master/packages/create-react-app)
63+
The global CLI command code can be found in this directory, and shouldn't often be changed. It should run on Node 0.10+.
64+
#### [eslint-config-react-app](https://github.com/facebookincubator/create-react-app/tree/master/packages/eslint-config-react-app)
65+
This package contains a conservative set of rules focused on making errors apparent and enforces no style rules.<br>
66+
This package is enabled by default for all `create-react-app` scaffolded applications.
67+
#### [react-dev-utils](https://github.com/facebookincubator/create-react-app/tree/master/packages/react-dev-utils)
68+
This package contains utilities used for `react-scripts` and sister packages.<br>
69+
Its main purpose is to conceal code which the user shouldn't be burdened with upon ejecting.
70+
#### [react-scripts](https://github.com/facebookincubator/create-react-app/tree/master/packages/react-scripts)
71+
This package is the heart of the project, which contains the scripts for setting up the development server, building production builds, configuring all software used, etc.<br>
72+
All functionality must be retained (and configuration given to the user) if they choose to eject.
73+
4474
## Setting Up a Local Copy
4575

4676
1. Clone the repo with `git clone https://github.com/facebookincubator/create-react-app`

0 commit comments

Comments
 (0)