From 537f951f876e8ebc65da8469c0621ae08216aba4 Mon Sep 17 00:00:00 2001 From: Romain Lenzotti Date: Sat, 24 Jun 2023 09:15:47 +0200 Subject: [PATCH] docs: update CONTRIBUTING.md --- CONTRIBUTING.md | 20 ++++++++++++++------ 1 file changed, 14 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d83432fea43..6a0e0040d00 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -56,24 +56,32 @@ Install npm dependencies with yarn (not with NPM!): ```bash yarn +yarn tsc --build ``` -> After installing dependencies, yarn/npm run the `postinstall` hook and mounted all packages with `npm link` (e.g. `yarn run repo:bootstrap`). +::: tip +For developers that use `Intellij`, you have to enable the "Recompile on change" option in `Languages & Frameworks` > `TypeScript`. +::: -Compile TypeScript: + +### Recompile source + +```bash +yarn tsc --build +``` + +### Prepare packages + +Compile all packages to publish it on NPM registry. It generate a `./dist` directory on root repository: ```bash yarn build -// or -npm run build ``` ### Test ```bash yarn test -# or -npm run test ``` ### Start a feature branch