Skip to content

Commit

Permalink
docs: update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
Romakita authored Jun 24, 2023
1 parent 417d0a0 commit 537f951
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 537f951

Please sign in to comment.