Skip to content

Commit c90148b

Browse files
authored
Start a guide on how to locally run PRs (#1822)
1 parent ed52f09 commit c90148b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

CONTRIBUTING.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -96,6 +96,21 @@ _If you're looking into contributing to the docs, follow the [instructions](#bui
9696
9797
1. Open the docs application in the browser [http://localhost:3003/toolpad](http://localhost:3003/toolpad)
9898
99+
## Reviewing PRs
100+
101+
- Check out the PR branch locally with your tool of choice ([GitHub Docs](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/reviewing-changes-in-pull-requests/checking-out-pull-requests-locally?tool=cli))
102+
- Run to build the project
103+
104+
```sh
105+
yarn && yarn release:build
106+
```
107+
108+
- Run it on your project of choice
109+
110+
```sh
111+
yarn toolpad dev /path/to/my/toolpad/project
112+
```
113+
99114
## Integration tests
100115
101116
- To run Toolpad on a fixture

0 commit comments

Comments
 (0)