summaryrefslogtreecommitdiff
path: root/.github
diff options
context:
space:
mode:
authorMaze <167211895+mazeincoding@users.noreply.github.com>2025-07-12 16:39:29 +0200
committerGitHub <noreply@github.com>2025-07-12 16:39:29 +0200
commit25d12a6fa44cf61dbfaf43f6ea629c5c3569aa28 (patch)
treea7b03860ae587ecc807e35c4fae839bb4c0bcc8d /.github
parenta9b02df2e31301ce1ab7867699701e8ea06231e8 (diff)
parentd9d54df431586775a19bf162f02d545ae5c4beb9 (diff)
downloadopencut-25d12a6fa44cf61dbfaf43f6ea629c5c3569aa28.tar.gz
Merge pull request #183 from youknowom/improve-contributing
docs: add note about npm workspace error and bun recommendation
Diffstat (limited to '.github')
-rw-r--r--.github/CONTRIBUTING.md5
1 files changed, 5 insertions, 0 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index b9e22759..989278c3 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -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