Skip to content

Commit c98057d

Browse files
authored
Update contributing.md with unit test docs (#1022)
1 parent 61c79a1 commit c98057d

File tree

1 file changed

+19
-8
lines changed

1 file changed

+19
-8
lines changed

CONTRIBUTING.md

Lines changed: 19 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,21 @@ see them reflected in real-time.
5252
The development stack mounts volumes locally for persisting storage under
5353
`.volumes`. Clear this directory to reset ClickHouse and MongoDB storage.
5454

55+
### Windows
56+
57+
If you are running WSL 2, Hot module reload on Nextjs (Frontend) does not work
58+
out of the box on windows when run natively on docker. The fix here is to open
59+
project directory in WSL and run the above docker compose commands directly in
60+
WSL. Note that the project directory should not be under /mnt/c/ directory. You
61+
can clone the git repo in /home/{username} for example.
62+
63+
To develop from WSL, follow instructions
64+
[here](https://code.visualstudio.com/docs/remote/wsl).
65+
5566
## Testing
5667

68+
### Integration Tests
69+
5770
To run the tests locally, you can run the following command:
5871

5972
```bash
@@ -66,16 +79,14 @@ If you want to run a specific test file, you can run the following command:
6679
make dev-int FILE=checkAlerts
6780
```
6881

69-
### Windows
82+
### Unit Tests
7083

71-
If you are running WSL 2, Hot module reload on Nextjs (Frontend) does not work
72-
out of the box on windows when run natively on docker. The fix here is to open
73-
project directory in WSL and run the above docker compose commands directly in
74-
WSL. Note that the project directory should not be under /mnt/c/ directory. You
75-
can clone the git repo in /home/{username} for example.
84+
To run unit tests or update snapshots, you can go to the package you want (ex.
85+
common-utils) to test and run:
7686

77-
To develop from WSL, follow instructions
78-
[here](https://code.visualstudio.com/docs/remote/wsl).
87+
```bash
88+
yarn dev:unit
89+
```
7990

8091
## Additional support
8192

0 commit comments

Comments
 (0)