docs: update CONTRIBUTING.md with prerequisites and dependencies table#775
Merged
PaulHax merged 2 commits intoKitware:mainfrom Aug 20, 2025
Merged
docs: update CONTRIBUTING.md with prerequisites and dependencies table#775PaulHax merged 2 commits intoKitware:mainfrom
PaulHax merged 2 commits intoKitware:mainfrom
Conversation
✅ Deploy Preview for volview-dev ready!Built without sensitive environment variables
To edit notification comments on pull requests, go to your Netlify project configuration. |
PaulHax
reviewed
Aug 19, 2025
Comment on lines
+38
to
+50
| | Package | Version | | ||
| |------------------------|-------------| | ||
| | Vite | ^4.5.2 | | ||
| | Vue | ^3.5.13 | | ||
| | TypeScript | ~5.1.3 | | ||
| | Vitest | ^0.32.1 | | ||
| | Vuetify | 3.7.0 | | ||
| | Pinia | ^2.0.34 | | ||
| | @kitware/vtk.js | ^32.12.1 | | ||
| | itk-wasm | 1.0.0-b.188 | | ||
| | @itk-wasm/dicom | 7.6.0 | | ||
| | @sentry/vue | ^7.54.0 | | ||
| | @vueuse/core | ^13.0.0 | |
Collaborator
There was a problem hiding this comment.
This will be hard to maintain. Lets just let the package.json hold this
PaulHax
reviewed
Aug 19, 2025
Comment on lines
25
to
29
| If you encounter errors about `package-lock.json` schema, regenerate it: | ||
|
|
||
| ```bash | ||
| rm package-lock.json | ||
| npm install |
Collaborator
There was a problem hiding this comment.
Deleting package-lock.json could cause bugs. Better to delete the node_modules folder. Lets just drop this basic how to hax javascript projects knolage and stick to volviews specific stuff.
Author
|
@PaulHax, thanks for your review comments. I have updated the branch based on your feedback. Please review and merge it. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR updates
CONTRIBUTING.mdto include environment prerequisites and a dependencies table.It helps contributors set up their environment correctly and avoid issues related to Node/npm/Vite compatibility.
Changes
package.json(Vite, Vue, TypeScript, Vuetify, Pinia, vtk.js, itk-wasm, etc.)package-lock.jsonif schema errors occurIssue
Closes #189