diff options
| author | Anwarul Islam <anwaarulislaam@gmail.com> | 2025-07-17 20:02:46 +0600 |
|---|---|---|
| committer | Anwarul Islam <anwaarulislaam@gmail.com> | 2025-07-17 20:02:46 +0600 |
| commit | 4d028487e695baf9693ca74916193dd66c49524e (patch) | |
| tree | 35e137c2ab403bdf072475e8f9fd6a35fea8aa13 /.github | |
| parent | f1fed515029ebdc7e29a976fd84b4e84cb0b5f03 (diff) | |
| download | opencut-4d028487e695baf9693ca74916193dd66c49524e.tar.gz | |
docs: clarify Docker setup note in contributing guidelines
Diffstat (limited to '.github')
| -rw-r--r-- | .github/CONTRIBUTING.md | 3 |
1 files changed, 2 insertions, 1 deletions
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index cf46f6a5..d6ce85ab 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -21,7 +21,6 @@ Thank you for your interest in contributing to OpenCut! This document provides g ``` 5. Install dependencies: `bun install` - 6. 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: @@ -60,6 +59,8 @@ If you're unsure whether your idea falls into the preview category, feel free to - Bun (latest version) - Docker (for local database) +> **Note:** Docker is optional, but it's essential for running the local database and Redis services. If you're planning to contribute to frontend features, you can skip the Docker setup. If you have followed the steps above in [Getting Started](#getting-started), you're all set to go! + ### Local Development 1. Start the database and Redis services: |