Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

doc(contributing): Update CONTRIBUTING.md for VTK.js development #439

Merged
merged 1 commit into from
Sep 27, 2023

Conversation

tbirdso
Copy link
Contributor

@tbirdso tbirdso commented Sep 26, 2023

Adds documentation to CONTRIBUTING.md with instructions on how to use a local development branch of VTK.js in a local VolView development build.

Also resolves observed type import error when developing against a local VTK.js development branch:

 ERROR  Error: The following dependencies are imported but could not be resolved:                             16:46:24

  @kitware/vtk.js/types (imported by C:/repos/VolView/src/components/tools/polygon/PolygonWidget2D.vue?id=0)

Are they installed?
    at file:///C:/repos/VolView/node_modules/vite/dist/node/chunks/dep-df561101.js:45705:23
    at process.processTicksAndRejections (node:internal/process/task_queues:95:5)
    at async file:///C:/repos/VolView/node_modules/vite/dist/node/chunks/dep-df561101.js:45114:38

@netlify
Copy link

netlify bot commented Sep 26, 2023

Deploy Preview for volview-dev ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit 389f953
🔍 Latest deploy log https://app.netlify.com/sites/volview-dev/deploys/65148bb9a998d00008b8cb9c
😎 Deploy Preview https://deploy-preview-439--volview-dev.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@tbirdso tbirdso changed the title WIP: Document development against local VTK.js branch doc(contributing): Update CONTRIBUTING.md for VTK.js development Sep 26, 2023
@tbirdso tbirdso marked this pull request as ready for review September 26, 2023 20:56
@tbirdso
Copy link
Contributor Author

tbirdso commented Sep 26, 2023

cc @floryst @PaulHax

@PaulHax PaulHax self-requested a review September 27, 2023 20:00
Copy link
Collaborator

@PaulHax PaulHax left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Beautiful docs.

lchauvin beat ya to my import type bug:
#431

Update CONTRIBUTING.md with steps to develop against a local VTK.js
development branch.

co-authored-by: Forrest Li <[email protected]>
@tbirdso
Copy link
Contributor Author

tbirdso commented Sep 27, 2023

Rebased in favor of #431

@PaulHax PaulHax merged commit d22cdd9 into Kitware:main Sep 27, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants