Skip to content

Commit

Permalink
updated contributing file and added build:watch script
Browse files Browse the repository at this point in the history
  • Loading branch information
piotrpospiech committed Sep 13, 2024
1 parent 3a8ae0d commit 8759b35
Show file tree
Hide file tree
Showing 2 changed files with 4 additions and 3 deletions.
6 changes: 3 additions & 3 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ Our kanban board is public and available [here](https://github.com/orgs/vazco/pr

- Create a fork from where you want to base your work.
- Clone the repo and run `npm ci` **in the top-level only**.
- Make sure you are using `npm` that understands the `package-lock.json` format. At the moment, it's at least v7.
- Make sure you are using `npm` that understands the `package-lock.json` format. Check the current version in the `package.json` file.
- Make sure your commit messages are in the proper format:
- Bugfix or feature:
- `Implemented asynchronous validation (closes #17).`
Expand All @@ -32,14 +32,14 @@ Our kanban board is public and available [here](https://github.com/orgs/vazco/pr

### Development

For the best local developer experience (DX) it is recommended to start `build` and `test` in `--watch` mode.
For the best local developer experience (DX) it is recommended to run scripts in watch mode.

Run the commands below in the root directory.

#### Running the build in watch mode

```sh
npm run build -- --watch
npm run build:watch
```

#### Running the tests in watch mode
Expand Down
1 change: 1 addition & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
"private": true,
"scripts": {
"build": "turbo build:cjs build:esm",
"build:watch": "turbo watch build:cjs build:esm",
"clean": "rimraf ./**/cjs ./**/esm && rimraf coverage",
"coverage": "jest --coverage",
"install": "npm run build && husky install",
Expand Down

0 comments on commit 8759b35

Please sign in to comment.