Skip to content

Commit

Permalink
doc(contributing): Update CONTRIBUTING.md for VTK.js development
Browse files Browse the repository at this point in the history
Update CONTRIBUTING.md with steps to develop against a local VTK.js
development branch.

co-authored-by: Forrest Li <[email protected]>
  • Loading branch information
tbirdso and floryst committed Sep 26, 2023
1 parent 8fcadfc commit 7c099ff
Showing 1 changed file with 27 additions and 1 deletion.
28 changes: 27 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,4 +43,30 @@ npm run test:e2e:chrome

When running end-to-end tests, baseline images are saved to `tests/baseline`. Baseline diffs and actual snapshots are saved to `.tmp`.

When adding a new baseline image and test, the image should be pulled from GitHub Actions. Every test run will upload artifacts containing the snapshots taken, and those should be used when verifying and committing the baseline images.
When adding a new baseline image and test, the image should be pulled from GitHub Actions. Every test run will upload artifacts containing the snapshots taken, and those should be used when verifying and committing the baseline images.

## Developing with VTK.js

Follow these steps to develop against a custom development branch of VTK.js:

1. Build and package VTK.js:
```sh
path/to/vtk-js > npm run build:esm
```

2. Create a symbolic link to the VTK.js distribution folder on your local system:
```sh
> cd path/to/vtk-js/dist/esm
path/to/vtk-js/dist/esm > npm link
```

3. Reference the symbolic link in your local VolView build:
```sh
> cd path/to/VolView
path/to/VolView > npm link --no-save @kitware/vtk.js
```

4. Build and run VolView:
```sh
path/to/VolView > npm run dev
```

0 comments on commit 7c099ff

Please sign in to comment.