Skip to content

Commit 30c0047

Browse files
pshrmntimdorr
authored andcommitted
Remove "hacking" section from CONTRIBUTING.md (remix-run#6478)
Removes outdated "hacking" section. Fixes remix-run#6460.
1 parent e65a00a commit 30c0047

File tree

1 file changed

+13
-5
lines changed

1 file changed

+13
-5
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,6 @@ Please read https://reactjs.org/ and the Code of Conduct before opening an issue
1010
- [Making a Pull Request?](#pr)
1111
- [Setup](#setup)
1212
- [Development](#development)
13-
- [Hacking](#hacking)
1413

1514
<a name="bug"/></a>
1615
## Think You Found a Bug?
@@ -69,6 +68,19 @@ npm run build
6968

7069
React Router uses a monorepo to host code for multiple packages. These packages live in the `packages` directory.
7170

71+
React Router uses Lerna to manage the monorepo. Lerna sets up symlinks between the packages, so when you build one package, its changes will be automatically available to the packages that depend on it.
72+
73+
### Building
74+
75+
Calling `npm run build` from the root directory will build every package. If you want to build a specific package, you should `cd` into that directory.
76+
```bash
77+
# build everything
78+
npm run build
79+
# build react-router-dom
80+
cd packages/react-router-dom
81+
npm run build
82+
```
83+
7284
### Testing
7385

7486
Calling `npm test` from the root directory will run **every** package's tests. If you want to run tests for a specific package, you should `cd` into that directory.
@@ -88,7 +100,3 @@ The code for the documentation website lives in the `website` directory. `cd` in
88100
cd website
89101
npm start
90102
```
91-
92-
## Hacking
93-
94-
The best way to hack on the router is to symlink it into your project using [`npm link`](https://docs.npmjs.com/cli/link). Then, use `npm run watch` to automatically watch the `modules` directory and output a new build every time something changes.

0 commit comments

Comments
 (0)