From 5e74906e1958d4a08ae45ba8c3efa45f8b1f2127 Mon Sep 17 00:00:00 2001 From: Omkaar Date: Thu, 10 Jul 2025 23:12:57 +0530 Subject: [PATCH 1/2] docs: add note about npm workspace error and bun recommendation --- .github/CONTRIBUTING.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index b9e2275..a71eff4 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -10,6 +10,8 @@ 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 using `npm install`, use **bun** or **pnpm** instead. + ## Development Setup ### Prerequisites From d9d54df431586775a19bf162f02d545ae5c4beb9 Mon Sep 17 00:00:00 2001 From: Omkaar Date: Thu, 10 Jul 2025 23:20:32 +0530 Subject: [PATCH 2/2] docs: update note to mention npm upgrade option --- .github/CONTRIBUTING.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a71eff4..989278c 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -10,7 +10,10 @@ 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 using `npm install`, use **bun** or **pnpm** instead. +> **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