Skip to content

Commit 4e9f634

Browse files
committed
chore: updating the contributing docs
1 parent 5323edb commit 4e9f634

File tree

1 file changed

+4
-2
lines changed

1 file changed

+4
-2
lines changed

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,10 @@
1313
- Dependencies inside of the packages and examples are automatically linked together as local/dynamic dependencies.
1414
- Run the build
1515
- `pnpm build`
16-
- Build an example app with the builder
17-
- `pnpm start app-js`
16+
- Build an example app with the builder. This is actually a little trick because if you build an app in the monorepo it will inherit the monorepo setup and won't work. So you need to have a temporary directory outside of the monorepo to create apps. An example test command command is below. The `-C` flag is used to the working directory of PNPM to the root of the CLI code, and the `--target-dir` flag is used to specify to the CLI the directory to create the app in.
17+
- `pnpm -C [root of the monorepo]/cli/create-tsrouter-app start --target-dir [temporary directory path]/app-js app-js`
18+
- Since you will probably be working on `./packages/cta-engine` a lot, you can run the following command to start the CLI in watch mode. After you have built the code at the root with `pnpm build`, you can run the following command to start the CLI in watch mode.
19+
- `cd ./packages/cta-engine && pnpm dev`
1820
- Run the `app-js` app just to make sure it works
1921
- Make changes to the code
2022
- Re-run `pnpm build` and `pnpm start` (in all its configurations) to make sure the changes work

0 commit comments

Comments
 (0)