Merge pull request #183 from youknowom/improve-contributing

docs: add note about npm workspace error and bun recommendation
This commit is contained in:
Maze
2025-07-12 16:39:29 +02:00
committed by GitHub

View File

@ -10,6 +10,11 @@ Thank you for your interest in contributing to OpenCut! This document provides g
4. Install dependencies: `bun install`
5. Start the development server: `bun run dev`
> **Note:** If you see an error like `Unsupported URL Type "workspace:*"` when running `npm install`, you have two options:
>
> 1. Upgrade to a recent npm version (v9 or later), which has full workspace protocol support.
> 2. Use an alternative package manager such as **bun** or **pnpm**.
## Development Setup
### Prerequisites