Skip to content

Commit 0607320

Browse files
- Improved the contributing.md file
1 parent bf49ef1 commit 0607320

File tree

1 file changed

+19
-2
lines changed

1 file changed

+19
-2
lines changed

packages/docs/docs/contributing.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,23 @@ If that is the situation for you, you can instead use `npm run build-serial` to
2929
Also, if you are only working on one package, you can `npm run build` and `npm run test` from within the subdirectory.
3030
Finally, you can simply `npm start` inside of the `playground` directory to test changes if you have already built all of your packages, without needing to watch all of the packages via the root directory `npm start`.
3131

32+
### Troubleshooting build failures
33+
34+
Sometimes your local builds fail and you can't figure out why. This is most likely to happen after rebase to `main` due
35+
to `package.json` changes upstream. There are two commands you can use to (hopefully) get your environment back to a
36+
working state. Try running the following two commands:
37+
38+
```bash
39+
npm run refresh-node-modules
40+
npm run clean-build
41+
```
42+
43+
The first command will delete all of the `node_modules` directories in the environment and then rerun `npm install`.
44+
The second command cleans up the typescript build cache files before retrying the build.
45+
46+
Worst case scenario when neither of those commands work, try deleting the `package-lock.json` and the entire `.nx` cache
47+
directory and rerun the commands again.
48+
3249
## Cloud builds
3350

3451
When building in environments with limited memory, such as Netlify, it's recommended to use `npm run build-serial` that builds the packages serially.
@@ -123,7 +140,7 @@ Code coverage reports are currently available only for the `@rjsf/core` theme pa
123140
They are generated using [nyc](https://github.com/istanbuljs/nyc) each time the `npm test-coverage` script is run.
124141
The full report can be seen by opening `./coverage/lcov-report/index.html`.
125142

126-
#### Utils and validator-ajvX code coverage
143+
#### Utils and validator-ajv8 code coverage
127144

128145
100% code coverage is required by the `@rjsf/utils` and `@rjsf/validator-ajv8` tests.
129146
If you make changes to those libraries, you will have to maintain that coverage, otherwise the tests will fail.
@@ -133,7 +150,7 @@ If you make changes to those libraries, you will have to maintain that coverage,
133150
## Releasing
134151

135152
To release, go to the main branch (NOT a fork) and then create a new branch with the version number (with an `rc` prefix instead of `v`).
136-
For instance if you are about to create the new `5.100.10` branch, then you would run the following commands:
153+
For instance if you are about to create the new `6.100.10` branch, then you would run the following commands:
137154

138155
```bash
139156
git checkout -b rc6.100.10

0 commit comments

Comments
 (0)