# Welcome to the Spacedrive Contributing Guide

Thank you for investing your time in contributing to our project!

Please read our [Code of Conduct](./CODE_OF_CONDUCT.md) to keep our community approachable and respectable.

This guide will provide an overview of the contribution workflow, including opening an issue, creating a pull request (PR), and the review and merge process.

> **Important: Spacedrive V2 Rewrite**
>
> Spacedrive underwent a complete architectural rewrite in early 2025. If you contributed to V1, please read the [Migration Guide for V1 Contributors](#migrating-from-v1) section below to understand the major changes.
>
> **TL;DR:** V1 used Tauri + React + Prisma. V2 is Rust-first with native Swift apps, SeaORM, and a CLI. Most of the stack was replaced to address fundamental architectural issues detailed in our [history document](docs/overview/history.mdx).

## New Contributor Guide

To familiarize yourself with the project, please read the [README](README.md). Here are some resources to help you get started with open-source contributions:

- [Finding ways to contribute to open-source on GitHub](https://docs.github.com/en/get-started/exploring-projects-on-github/finding-ways-to-contribute-to-open-source-on-github)
- [Setting up Git](https://docs.github.com/en/get-started/quickstart/set-up-git)
- [GitHub flow](https://docs.github.com/en/get-started/quickstart/github-flow)
- [Collaborating with pull requests](https://docs.github.com/en/github/collaborating-with-pull-requests)
- [Spacedrive Architecture Documentation](docs/core/architecture.mdx)
- [V1 to V2 Migration Guide](#migrating-from-v1) (for returning contributors)

## Getting Started

### Issues

#### Creating a New Issue

If you come across an issue or have a feature request for Spacedrive, please [search if a related issue has already been reported](https://docs.github.com/en/github/searching-for-information-on-github/searching-on-github/searching-issues-and-pull-requests#search-by-the-title-body-or-comments). If no relevant issue exists, you can open a new issue using the appropriate [issue form](https://github.com/spacedriveapp/spacedrive/issues/new/choose).

#### Solving an Issue

To find an issue that interests you, you can browse through our [existing issues](https://github.com/spacedriveapp/spacedrive/issues) and use the available `labels` to narrow down your search (See [Labels](https://github.com/spacedriveapp/spacedrive/labels) for more information). As a general rule, if you find an issue you want to work on, you are welcome to open a PR with a fix.

## Development Setup

Spacedrive V2 is built with a **Rust-first architecture**. The core Virtual Distributed File System (VDFS) is pure Rust, with native Swift apps for iOS/macOS maintained as separate submodules to keep Spacedrive recognized as a Rust project on GitHub.

### Prerequisites

Before you begin, ensure you have the following installed:

| Tool  | Version                        | Required For                    |
| ----- | ------------------------------ | ------------------------------- |
| Rust  | [`1.81+`](rust-toolchain.toml) | Core development                |
| Bun   | 1.3+                           | Desktop app (Tauri) development |
| Xcode | Latest                         | iOS/macOS development           |
| Git   | Any recent version             | Version control & submodules    |

**Note:** Bun is required for the Tauri desktop app. Install from [bun.sh](https://bun.sh). For CLI-only development, Bun is not required.

[`rustup`](https://rustup.rs/) should automatically pick up the correct Rust version from the project's `rust-toolchain.toml`.

### Clone the Repository

```bash
git clone https://github.com/spacedriveapp/spacedrive
cd spacedrive
```

If you plan to work on GUI applications, initialize the submodules:

Some submodules are private, such as tha landing page and future extensions.

```bash
git submodule update --init --recursive
```

### System Dependencies

There are two setup steps: system dependencies and project dependencies.

#### Step 1: System Dependencies (Linux only)

On Linux, run the setup script to install required system packages:

```bash
./scripts/setup.sh
```

This installs platform-specific dependencies (GTK, WebKit, etc.) required for building the Tauri desktop app.

**macOS users:** Skip this step. Xcode provides all necessary dependencies.

**Windows:**

```powershell
.\scripts\setup.ps1
```

For mobile development, run:

```bash
./scripts/setup.sh mobile
```

This installs additional Rust targets for iOS and Android cross-compilation.

#### Step 2: Project Dependencies

After system dependencies are installed, set up the project:

```bash
# Install JavaScript dependencies (required for Tauri app)
bun install

# Download native dependencies and generate cargo config
cargo run -p xtask -- setup

# Build core Rust binaries (CLI, daemon, and core library)
# Note: Basic build without media features
cargo build

# OR build with media processing features (recommended for development)
cargo build --features sd-core/ffmpeg,sd-core/heif
```

The `xtask setup` command:

- Downloads prebuilt native dependencies (FFmpeg, etc.)
- Creates symlinks for shared libraries
- Builds the release daemon for Tauri bundler validation
- Generates `.cargo/config.toml` with cargo aliases (including `cargo daemon` and `cargo cli`)
- Downloads iOS dependencies if iOS targets are installed

**Important:** After running `xtask setup`, you can use convenient aliases:
```bash
cargo daemon  # Runs sd-daemon with ffmpeg,heif features enabled
cargo cli     # Runs sd-cli with ffmpeg,heif features enabled
```

**Note:** The release daemon build is required because Tauri's `externalBin` config validates binary paths even in dev mode. The daemon is built once during setup and rebuilt when needed during release builds.

#### Optional: ML-SHARP for Gaussian Splat Generation

Spacedrive can generate 3D Gaussian splats from images using [ml-sharp](https://github.com/spacedriveapp/ml-sharp), which implements Apple's SHARP model. This feature is optional and requires manual installation.

> **Note:** We plan to bundle ml-sharp with Spacedrive's native dependencies in a future release. For now, manual installation is required.

**Installation:**

```bash
# Clone ml-sharp repository
git clone https://github.com/spacedriveapp/ml-sharp
cd ml-sharp

# Install in development mode (requires Python 3.10+)
pip install -e .

# Verify installation
sharp --help
```

Once installed, the `sharp` CLI will be available in your PATH and Spacedrive will automatically detect it. The "Generate 3D Splat" button in the file inspector will become functional for supported image types (JPEG, PNG, WebP, BMP, TIFF).

**What does `cargo build` build?**

Running `cargo build` from the project root builds all core Rust components:

- `sd-cli` - Command-line interface for Spacedrive
- `sd-daemon` - Background service (used by GUI apps)
- `sd-core` - Core library with VDFS implementation
- Various helper crates

**Important: Media Processing Features**

By default, `cargo build` compiles without optional features to speed up builds and avoid native dependency issues during testing. However, this means media processing features are **disabled by default**:

- ❌ **Without features:** No video thumbnails, no audio transcription, no HEIF image support
- ✅ **With `--features ffmpeg,heif`:** Full media processing capabilities

**For development, use:**
```bash
# Build with all media features (recommended)
cargo build --features sd-core/ffmpeg,sd-core/heif

# Or use the convenient aliases (after running `xtask setup`)
cargo daemon  # Automatically includes sd-core/ffmpeg,sd-core/heif features
cargo cli     # Automatically includes sd-core/ffmpeg,sd-core/heif features
```

The Tauri desktop app **always** includes these features by default, so end users get full functionality. This design keeps the test suite fast while giving developers easy access to full features when needed.

**Note:** The Tauri desktop app is excluded from `cargo build` because it requires the frontend to be built first. See [Desktop Development](#desktop-development-tauri) for Tauri-specific setup.

## Core Development

The heart of Spacedrive is the Rust core (`core/`). Most contributions will involve working with this codebase.

### Quick Start with CLI

The fastest way to start developing is with the CLI:

```bash
# Using the cargo alias (recommended - includes media features)
cargo cli library create "Dev Library"
cargo cli location add ~/Documents
cargo cli search .

# Or use the long form with features
cargo run --features sd-core/ffmpeg,sd-core/heif --bin sd-cli -- library create "Dev Library"
```

**Tip:** The `cargo cli` alias is created by `xtask setup` and automatically includes `ffmpeg,heif` features.

#### Setting Up a Shell Alias

For even shorter commands, add a shell alias:

**Bash/Zsh** (`~/.bashrc` or `~/.zshrc`):

```bash
alias sd="~/Projects/spacedrive/target/debug/sd-cli"
```

**Fish** (`~/.config/fish/config.fish`):

```fish
alias sd="~/Projects/spacedrive/target/debug/sd-cli"
```

Then reload your shell (`source ~/.zshrc`) and you can use:

```bash
sd library create "Dev Library"
sd location add ~/Documents
sd search .
```

**Note:** Update the path to match your Spacedrive project location. The binary is located at `target/debug/sd-cli` after running `cargo build` (or use `cargo cli` which includes media features).

### Running Tests

```bash
# Run all tests
cargo test

# Run tests for a specific package
cargo test -p sd-core

# Run tests with output
cargo test -- --nocapture
```

### Code Quality

Before submitting a PR, ensure your code passes all checks:

```bash
# Format code
cargo fmt

# Run linter
cargo clippy

# Run all checks
cargo fmt && cargo clippy && cargo test
```

### Working with Examples

The `core/examples/` directory contains working demonstrations of core features:

```bash
# Run the indexing demo
cargo run --example indexing_demo

# Run the file type detection demo
cargo run --example file_type_demo

# See all available examples
ls core/examples/
```

Examples are a great way to understand how different parts of the system work together.

## GUI Application Development

GUI applications (iOS, macOS, and the upcoming Desktop app) are maintained as **separate Git submodules**. This approach keeps the main repository focused on Rust code, ensuring Spacedrive is properly recognized as a Rust project on GitHub.

### Why Submodules?

With 35k+ stars, Spacedrive is one of the top 30 largest Rust projects globally, yet GitHub's language detection can misclassify it as TypeScript/Swift based on lines of code. Submodules solve this by keeping frontend code in separate repositories.

### Working with Submodules

#### Initialize All Submodules

```bash
git submodule update --init --recursive
```

#### Update Submodules to Latest

```bash
git submodule update --remote
```

#### Check Submodule Status

```bash
git submodule status
```

### Mobile Development (React Native)

The React Native mobile app provides cross-platform iOS and Android support with an embedded Spacedrive core. It uses Expo SDK 53 with React 19 and the New Architecture enabled.

#### Prerequisites

| Tool           | Version | Required For                               |
| -------------- | ------- | ------------------------------------------ |
| Bun            | 1.3+    | Package management                         |
| Xcode          | 26+     | iOS builds                                 |
| Rust           | 1.81+   | Core compilation                           |
| Go             | 1.20+   | Building aws-lc crypto library             |
| Android Studio | Latest  | Android builds, NDK (26.1.10909125), CMake |
| Java           | 17      | Android builds                             |

#### Quick Start
> [!important]
> If you're building for Android devices, it's imperative that you install NDK (26.1.10909125) and CMake in Android Studio's SDK Manager in order to build the aws-lc crypto library. You'll need to add the NDK path to your system's environment variable as `ANDROID_NDK` or `ANDROID_NDK_HOME`.

```bash
# 1. Install Go (required for aws-lc cryptographic library)
brew install go  # macOS
# or visit https://go.dev/dl/ for other platforms

# 2. Install Java (required for Android builds)
brew install openjdk@17 # macOS

# 2. Build the Rust core for mobile (from project root)
cargo xtask build-mobile

# 3. Install JavaScript dependencies
cd apps/mobile
bun install

# 4. Apply patches and prebuild native projects
# (Not required to ensure rebuilt core is bundled when making changes)
bun run prebuild:clean

# 5. Run on iOS simulator or Android emulator (from apps/mobile directory)
bun ios
bun android

# 6. Run on physical iOS or Android device (from apps/mobile directory)
bun ios --device "YourDeviceName"
bun android --device "YourDeviceName"
# You can find the device name by running `bunx expo devices`.
```

#### Development Commands

```bash
# From apps/mobile directory:

bun run ios              # Run on iOS simulator
bun run android          # Run on Android emulator
bun run start            # Start Metro bundler only
bun run prebuild         # Generate native projects
bun run prebuild:clean   # Clean and regenerate native projects
bun run xcode            # Open iOS project in Xcode
```

#### Architecture

The mobile app embeds the full Spacedrive core as a native library:

```
React Native App (Expo SDK 53)
    ↓
TypeScript Client (src/client/)
    ↓
Expo Native Module (modules/sd-mobile-core/)
    ↓
Swift/Kotlin FFI Bridge
    ↓
Rust Core (libsd_mobile_core.a)
```

**Key directories:**

- `apps/mobile/src/` - React Native TypeScript code
- `apps/mobile/modules/sd-mobile-core/` - Expo native module
- `apps/mobile/modules/sd-mobile-core/core/` - Rust FFI layer
- `apps/mobile/modules/sd-mobile-core/ios/` - Swift bridge
- `apps/mobile/modules/sd-mobile-core/android/` - Kotlin bridge

#### Building the Rust Core

The Rust core must be built manually before running the app. The build script in the podspec is intentionally commented out to avoid build issues during Xcode compilation.

```bash
# Build for iOS/Android (device + simulator) from project root. iOS will only build on MacOS
cargo xtask build-mobile

# Libraries are output to:

# iOS
# apps/mobile/modules/sd-mobile-core/ios/libs/device/libsd_mobile_core.a
# apps/mobile/modules/sd-mobile-core/ios/libs/simulator/libsd_mobile_core.a

# Android
# apps/mobile/modules/sd-mobile-core/android/src/main/jniLibs/arm64-v8a/libsd_mobile_core.so
# apps/mobile/modules/sd-mobile-core/android/src/main/jniLibs/x86_64/libsd_mobile_core.so
```

#### Known Issues and Fixes

**SSL certificate errors with Hermes (physical device builds):**
When building for physical devices, you may encounter SSL certificate verification errors during pod install. Use the `RCT_BUILD_HERMES_FROM_SOURCE=true` environment variable to build Hermes from source instead of downloading prebuilt binaries:

```bash
RCT_BUILD_HERMES_FROM_SOURCE=true bunx expo run:ios --device "YourDevice"
```

**aws-lc-sys build failures:**
If you see errors about missing Go or CMake errors during `cargo xtask build-mobile`:

1. Install Go: `brew install go` (required for aws-lc cryptographic library)
2. Clean cargo cache: `rm -rf ~/.cargo/registry/src/*/aws-lc-sys-*`
3. Rebuild: `cargo xtask build-mobile`

**react-native-svg Yoga compatibility:**
The `bun run prebuild` command automatically patches `react-native-svg` for Yoga 3.0 compatibility. If you see `StyleLength` errors, run `bun run patch` manually.

**React version mismatch:**
React must be pinned to 19.0.0 in the workspace root's `package.json` overrides to match `react-native-renderer`. If you see version mismatch errors, verify the root `package.json` has:

```json
"overrides": {
  "react": "19.0.0"
}
```

**Metro cache issues:**
Clear Metro cache if you encounter bundling issues:

```bash
bun run start -- --reset-cache
```

**Xcode build database locked:**
If you see "database is locked" errors, a previous build is still running. Kill it and clean:

```bash
pkill -f xcodebuild
rm -rf ~/Library/Developer/Xcode/DerivedData/Spacedrive-*
```

**Android build errors:**
`"Android NDK not found. Set ANDROID_NDK or ANDROID_NDK_HOME"`

If you haven't already, you'll need to install NDK (26.1.10909125) and CMake from Android Studio and add it as an environment variable to your system as either `ANDROID_NDK` or `ANDROID_NDK_HOME`. You can find the directory in the path of your Android SDK.

#### Adding New Native Functionality

To add new native functionality exposed to JavaScript:

1. Add Rust FFI function in `modules/sd-mobile-core/core/src/lib.rs`
2. Add Swift bridge in `modules/sd-mobile-core/ios/SDMobileCoreModule.swift`
3. Add Kotlin bridge in `modules/sd-mobile-core/android/.../SDMobileCoreModule.kt`
4. Export from `modules/sd-mobile-core/src/index.ts`
5. Rebuild the Rust core: `cargo xtask build-mobile` (from project root)
6. Regenerate native projects: `cd apps/mobile && bun run prebuild:clean`

**Important:** Always rebuild the Rust core with `cargo xtask build-mobile` after modifying Rust code. The podspec build script is intentionally disabled to avoid Xcode build issues.

### Desktop Development (Tauri)

The cross-platform desktop app uses Tauri with a React frontend. Unlike the native iOS/macOS apps, the Tauri app lives directly in the main repository at `apps/tauri/`.

#### Prerequisites

In addition to the standard prerequisites, you need:

| Tool | Version | Required For                  |
| ---- | ------- | ----------------------------- |
| Bun  | 1.3+    | Frontend build and dev server |

Install Bun from [bun.sh](https://bun.sh) if you don't have it.

#### Fresh Start Setup

From a clean clone, follow these steps in order:

```bash
# 1. Clone the repository
git clone https://github.com/spacedriveapp/spacedrive
cd spacedrive

# 2. Install JavaScript dependencies (from repo root)
bun install

# 3. Setup native dependencies and generate cargo config
cargo run -p xtask -- setup

# 4. Run the desktop app in development mode
cd apps/tauri
bun run tauri:dev
```

The `tauri:dev` command will:

1. Start the Vite dev server (serves the React frontend)
2. Start the sd-daemon (Rust backend)
3. Compile and launch the Tauri app
4. Connect the app to the dev server with hot reload

#### Tauri Build Errors

As of the V2 rewrite, `cargo build` from the project root **no longer builds the Tauri app** - it's excluded from the default workspace members to prevent frontend dependency issues.

**Error: `resource path '../../../target/release/sd-daemon-{target}' doesn't exist`**

This occurs when Tauri tries to validate the `externalBin` path but the release daemon hasn't been built yet. Tauri expects the daemon binary with a target triple suffix (e.g., `sd-daemon-aarch64-apple-darwin`, `sd-daemon-x86_64-pc-windows-msvc`).

Solution:

```bash
# Run setup to build the release daemon and create the target-suffixed copy
cargo run -p xtask -- setup
```

The `xtask setup` command automatically builds the release daemon and creates the platform-specific target-suffixed copy that Tauri expects.

If you still encounter the `frontendDist` error:

```
error: proc macro panicked
  --> apps/tauri/src-tauri/src/main.rs
     |
     = help: message: The `frontendDist` configuration is set to `"../dist"` but this path doesn't exist
```

This means you're explicitly building the Tauri package. Solutions:

**Option A: Use tauri:dev for development (recommended)**

```bash
cd apps/tauri
bun run tauri:dev  # Starts dev server with hot reload
```

**Option B: Build the frontend first**

```bash
cd apps/tauri
bun run build      # Creates dist/ folder
cargo build -p spacedrive-tauri  # Now succeeds
```

#### Development Commands

```bash
# From apps/tauri directory:

bun run tauri:dev           # Development mode with hot reload
bun run tauri:dev:no-watch  # Development without Rust hot reload
bun run tauri:build         # Production build
bun run dev                 # Frontend only (Vite dev server)
bun run build               # Frontend only (Vite build)
```

#### Architecture Notes

The Tauri app consists of:

- `apps/tauri/` - React frontend (Vite + React)
- `apps/tauri/src-tauri/` - Rust Tauri shell
- `apps/tauri/sd-tauri-core/` - Tauri-specific core bindings

The app connects to `sd-daemon` which manages libraries and P2P connections. In dev mode, the daemon is started automatically by the `dev:with-daemon` script.

## Extension Development

Spacedrive supports WASM-based extensions for adding custom functionality. Extensions run in sandboxed environments with full access to the Spacedrive SDK.

### Getting Started with Extensions

```bash
# Navigate to extensions directory
cd extensions/

# Create a new extension from template
cargo generate --path template

# Build an extension
cd your-extension
cargo build --target wasm32-unknown-unknown
```

For comprehensive extension development documentation, see [`docs/extensions/introduction.mdx`](docs/extensions/introduction.mdx).

## TypeScript Client Development

The TypeScript client (`packages/ts-client`) provides a type-safe interface to the Spacedrive daemon. Types are automatically generated from Rust definitions.

### Generate TypeScript Types

```bash
# From the ts-client directory
cd packages/ts-client
bun run generate-types

# Or run directly from core
cargo run --bin generate_typescript_types --manifest-path core/Cargo.toml
```

### Build the Client

```bash
cd packages/ts-client
bun install
bun build
```

The TypeScript client is primarily used by the desktop GUI (future) and can be used to build custom interfaces.

## Architecture Overview

Spacedrive V2 introduces several architectural improvements over V1:

- **Entry-Centric Model**: Files and directories unified as Entries with optional content identity
- **SdPath Addressing**: Universal file addressing across devices and storage types
- **Event-Driven**: EventBus eliminates coupling between core subsystems
- **CQRS Pattern**: Actions (mutations) and Queries (reads) with preview-commit-verify flow
- **Durable Jobs**: Long-running operations survive app restarts via MessagePack serialization
- **Domain-Separated Sync**: Leaderless P2P sync with HLC timestamps

For deep-dive architecture documentation, see [`docs/core/architecture.mdx`](docs/core/architecture.mdx).

## Submitting a Pull Request

Once you have finished making your changes, create a pull request (PR) to submit them.

### Before Submitting

1. **Run all checks:**

   ```bash
   cargo fmt && cargo clippy && cargo test
   ```

2. **Update documentation** if you've changed public APIs

3. **Add tests** for new functionality

4. **Test on relevant platforms** (especially for iOS/macOS changes)

### Creating the PR

- Fill out the PR template to help reviewers understand your changes
- [Link your PR to an issue](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) if addressing an existing issue
- Enable the checkbox to [allow maintainer edits](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/allowing-changes-to-a-pull-request-branch-created-from-a-fork)
- A team member will review your proposal and may request changes
- Mark conversations as [resolved](https://docs.github.com/en/github/collaborating-with-issues-and-pull-requests/commenting-on-a-pull-request#resolving-conversations) as you address feedback

## Your PR is Merged!

Congratulations! The Spacedrive team thanks you for your contribution!

Once your PR is merged, your changes will be included in the next release of the application.

## Troubleshooting

### Rust Compilation Issues

**Error: Could not compile `sd-core`**

- Ensure you're using Rust 1.81+ (`rustup update`)
- Clean build artifacts: `cargo clean`
- Check that all dependencies are installed via setup script

**Error: Linking failed**

- On Linux, ensure all system dependencies are installed
- Run `./scripts/setup.sh` again to verify dependencies

### Media Processing Features Not Working

**Error:** "Feature is not enabled" or media buttons (transcription, thumbnails, thumbstrips) fail in the UI

**Cause:** The daemon was built without the `ffmpeg` and `heif` features.

**Solution:**

```bash
# Build with media features enabled
cargo build --features sd-core/ffmpeg,sd-core/heif

# Or use the convenient alias (recommended)
cargo daemon

# Then restart your daemon
sd stop
sd start
```

**Why does this happen?**

- `cargo build` (without features) compiles a minimal daemon for faster builds and testing
- Media processing features require native dependencies (FFmpeg, libheif) which can cause issues in CI
- GUI apps (Tauri, iOS, macOS) always include these features by default
- CLI/daemon developers should use `cargo daemon` or `cargo cli` aliases for full functionality

### ARM Build Issues (Apple Silicon)

#### `whisper-rs-sys` CMake build errors with i8mm instructions

**Error:** `always_inline function 'vmmlaq_s32' requires target feature 'i8mm'`

This occurs during the CMake compilation of whisper-rs-sys on ARM platforms (Apple Silicon) where the compiler tries to use ARMv8.6-A i8mm (integer 8-bit matrix multiply) instructions that may not be available on all systems or CI runners.

**Solution:**

The project is configured to use Metal GPU acceleration on macOS/iOS, which avoids CPU SIMD issues. If you still encounter this error:

```bash
# Set compiler flags to target ARMv8.2-A with crypto extensions
export CFLAGS="-march=armv8.2-a+crypto"
export CXXFLAGS="-march=armv8.2-a+crypto"
cargo build
```

#### `aws-lc-sys` NEON/crypto extension errors

**Error:** `NEON and crypto extensions should be statically available`

This occurs when building aws-lc-sys (used for cryptography) on ARM without proper architecture flags.

**Solution:**

Ensure you're targeting ARMv8.2-A or later with crypto extensions:

```bash
export CFLAGS="-march=armv8.2-a+crypto"
export CXXFLAGS="-march=armv8.2-a+crypto"
cargo build
```

These flags enable:
- NEON (Advanced SIMD) instructions
- Crypto extensions (AES, SHA2)
- Excludes i8mm to avoid incompatibility issues

#### `whisper-rs-sys` CMake Metal framework error on Linux

**Error:** `CMake Error: Could not find FOUNDATION_LIBRARY using the following names: Foundation`

This occurs when building on Linux with Metal features enabled. Metal is an Apple-only framework and cannot be built on non-Apple platforms.

**Solution:**

The project automatically handles this via platform-specific dependencies in `core/Cargo.toml`. Metal is only enabled on macOS/iOS. If you encounter this error, ensure you're using the latest version of the code where whisper-rs uses platform-specific features.

### Xcode Issues

#### `xcrun: error: unable to find utility "xctest"`

This occurs when Xcode command line tools are not properly configured.

**Solution:**

```bash
# Install Xcode from App Store
# Then configure command line tools
xcode-select -s /Applications/Xcode.app/Contents/Developer
```

#### `unable to lookup item 'PlatformPath'`

This typically indicates outdated command line tools.

**Solution:**

```bash
# Ensure macOS is fully updated
# Install/update command line tools
xcode-select --install

# Install Rosetta (required for some dependencies on Apple Silicon)
softwareupdate --install-rosetta --agree-to-license
```

### Submodule Issues

#### Submodules not initialized

**Error:** `apps/ios` directory is empty or missing files

**Solution:**

```bash
git submodule update --init --recursive
```

#### Submodule pointing to wrong commit

After pulling latest changes, submodules may be out of sync.

**Solution:**

```bash
git submodule update --remote
```

#### Changes in submodule not showing

If you've made changes inside a submodule directory:

```bash
# Commit within the submodule
cd apps/ios
git add .
git commit -m "Your changes"

# Then commit the submodule reference in main repo
cd ../..
git add apps/ios
git commit -m "Update iOS submodule"
```

### iOS/macOS Build Issues

#### Core library not found

**Error:** `sd-ios-core` framework not found

**Solution:**

```bash
# From the project root
cargo ios
# Or the full command:
cargo xtask build-ios
```

#### Swift client compilation errors

If you've updated Rust types, regenerate Swift bindings:

```bash
# The swift-client uses generated types from specta
# Rebuild the core to regenerate types
cargo build -p sd-core
```

### Test Failures

If tests fail locally:

```bash
# Run specific test with output
cargo test test_name -- --nocapture

# Check for database issues
rm -rf ~/.local/share/spacedrive  # Remove test databases
cargo test
```

## Migrating from V1

If you contributed to Spacedrive V1 (the 35k+ star version visible on GitHub from 2022-2024), welcome back! V2 is a ground-up rewrite that addresses every architectural flaw that made V1 unmaintainable. This section helps you understand what changed and how your V1 knowledge maps to V2.

### Why the Rewrite?

V2 wasn't perfectionism—V1 became fundamentally broken:

- **Prisma deprecated** - No migration path for our database layer
- **libp2p unreliable** - P2P transfers constantly failed
- **No extensibility** - Community couldn't build on top
- **Dual file systems** - Incompatible indexed vs ephemeral files
- **Development paralysis** - Simple features required 1000+ lines of boilerplate

Read the full analysis in [docs/overview/history.mdx](docs/overview/history.mdx).

### Architecture Changes at a Glance

| Aspect              | V1 (PRRTT Stack)                  | V2 (Rust-First)                                                                        |
| ------------------- | --------------------------------- | -------------------------------------------------------------------------------------- |
| **Database**        | Prisma (deprecated)               | SeaORM                                                                                 |
| **Type Generation** | rspc                              | Specta (TypeScript + Swift)                                                            |
| **Desktop**         | Tauri + React (in repo)           | Swift (native macOS submodule) / Tauri + React (cross platform submodule, coming soon) |
| **Mobile**          | React Native                      | Native Swift (iOS/macOS submodules)                                                    |
| **P2P Networking**  | libp2p                            | Iroh (QUIC-based)                                                                      |
| **File Model**      | Dual system (indexed + ephemeral) | Unified Entry + SdPath                                                                 |
| **RPC**             | rspc procedures                   | Specta-generated types                                                                 |
| **Extensibility**   | None                              | WASM SDK                                                                               |
| **CLI**             | Planned                           | Production-ready (`sd-cli`)                                                            |
| **Job System**      | 1000+ lines boilerplate           | ~50 lines with macros                                                                  |
| **Sync**            | Custom CRDT (incomplete)          | HLC timestamps (works)                                                                 |

### Development Workflow Changes

**V1 Workflow:**

```bash
bun install
bun prep  # Generate Prisma client + rspc types
bun tauri dev  # Desktop
bun mobile ios  # React Native mobile
cargo run -p sd-server  # Backend server
```

**V2 Workflow:**

```bash
bun install                              # Install JS dependencies
cargo run -p xtask -- setup              # Setup native deps and cargo config
cargo cli library create "My Library"    # CLI-first (includes media features)
cargo daemon                             # Or run daemon separately (includes media features)
cd apps/tauri && bun run tauri:dev       # Desktop app (includes media features by default)
open apps/ios/Spacedrive.xcodeproj       # Native iOS (submodule)
```

### File Structure Comparison

**V1 Monorepo:**

```
apps/
  desktop/        # Tauri app (main repo)
  mobile/         # React Native
  web/            # React SPA
  landing/        # Next.js
  server/         # Rust backend
  storybook/      # Component docs
interface/        # Shared React components
packages/
  client/         # rspc client (@sd/client)
  ui/             # Shared UI components
  config/         # ESLint/TS configs
core/
  prisma/         # Prisma schema
  src/            # Rust core
```

**V2 Structure:**

```
core/             # Pure Rust (VDFS implementation)
  src/
    domain/       # Core models
    ops/          # CQRS operations
    infra/        # DB, jobs, events, sync
    service/      # High-level services
apps/
  cli/            # Production CLI
  ios/            # Native Swift app (SUBMODULE)
  macos/          # Native Swift app (SUBMODULE)
  desktop/        # Future: Tauri app (SUBMODULE)
extensions/       # WASM extensions
packages/
  ts-client/      # Minimal TypeScript client
  swift-client/   # Shared Swift client
  ui/             # Minimal shared UI
```

### What Happened to My Favorite V1 Component?

**Desktop GUI (`apps/desktop`):**

- **Status:** Will return as a submodule (Tauri + React, like V1)
- **Why submodule:** Keep Spacedrive categorized as Rust on GitHub
- **Migration:** Desktop contributors should wait for submodule or contribute to native apps

**React Native Mobile (`apps/mobile`):**

- **Status:** Ported to V2 with embedded core (Expo SDK 53, React 19)
- **Why:** Cross-platform support for iOS and Android with embedded Spacedrive core
- **Migration:** V1 React Native knowledge transfers well; see [Mobile Development](#mobile-development-react-native)

**Interface Package (`interface/`):**

- **Status:** Removed; UI now lives in individual app submodules
- **Migration:** Desktop UI will be in `apps/desktop` submodule when added

**Prisma Client (`core/prisma`):**

- **Status:** Replaced with SeaORM
- **Migration:** Learn SeaORM migration system and entity definitions

**rspc (`packages/client`):**

- **Status:** Replaced with Specta for type generation
- **Migration:** Types now generated from Rust using Specta for both TypeScript and Swift

**libp2p Networking:**

- **Status:** Replaced with Iroh
- **Why:** More reliable P2P with better NAT traversal
- **Migration:** Iroh API is different; review networking code in `core/src/service/network/`

### Breaking Changes for Contributors

#### Database Layer

- **V1:** Prisma schema → `prisma generate` → Rust client
- **V2:** SeaORM entities → Migrations in `core/src/infra/db/migration/`
- **Learn:** [SeaORM docs](https://www.sea-ql.org/SeaORM/)

#### Type Safety Across Boundaries

- **V1:** rspc procedures with TypeScript codegen
- **V2:** Specta generates both TypeScript and Swift types
- **Example:**

  ```rust
  // V1 (rspc)
  .query("getLibrary", |t| t(|ctx, input: String| async move { ... }))

  // V2 (Specta)
  #[derive(Serialize, Deserialize, Type)]
  pub struct Library { ... }
  // Types auto-generated for TS and Swift
  ```

#### Job System

- **V1:** Manual boilerplate (500-1000 lines per job)
- **V2:** Derive macro (~50 lines)
- **Example:**
  ```rust
  // V2
  #[derive(Job)]
  pub struct IndexerJob {
      location_id: Uuid,
  }
  ```

#### File Operations

- **V1:** Dual system (indexed `FilePath` vs ephemeral)
- **V2:** Unified `Entry` model with `SdPath` addressing
- **Learn:** Read `core/src/domain/entry.rs` and SdPath in docs

### Where Should V1 Contributors Focus?

**If you worked on:**

**Core/Rust:**

- Your knowledge transfers well
- Learn SeaORM, Specta, and the new domain-driven structure
- Focus on `core/src/domain/` and `core/src/ops/`

**Desktop GUI:**

- Wait for `apps/desktop` submodule or contribute to native apps
- React/TypeScript skills will transfer when desktop submodule is added

**Mobile:**

- iOS/macOS are now native Swift apps
- Learn SwiftUI or contribute to core Rust (embedded in apps)
- Check `apps/ios/README.md` for architecture

**Database/Migrations:**

- Completely different system (SeaORM vs Prisma)
- Learn SeaORM migrations
- Focus on `core/src/infra/db/`

**Networking/P2P:**

- Iroh replaced libp2p entirely
- Learn Iroh's QUIC-based approach
- Focus on `core/src/service/network/`

**Search:**

- Now using FTS5 with semantic re-ranking
- Focus on `core/src/infra/search/`

**Extensions/SDK:**

- **New in V2!** WASM-based extension system
- Check `extensions/` and `docs/extensions/`

### Quick Reference: Command Mapping

| V1 Command               | V2 Equivalent                                            |
| ------------------------ | -------------------------------------------------------- |
| `bun install`            | `bun install` (still required for Tauri app)             |
| `bun prep`               | `cargo run -p xtask -- setup`                            |
| `bun tauri dev`          | `cd apps/tauri && bun run tauri:dev`                     |
| `bun mobile ios`         | `cd apps/mobile && bun run ios`                          |
| `bun mobile android`     | `cd apps/mobile && bun run android`                      |
| `cargo run -p sd-server` | `cargo cli` or `cargo daemon` (includes media features)  |
| `bun dev:web`            | Not yet available (web in progress)                      |

### Getting Help with Migration

- **Read the history:** [docs/overview/history.mdx](docs/overview/history.mdx) explains every V1 failure
- **Architecture docs:** [docs/core/architecture.mdx](docs/core/architecture.mdx) explains V2 design
- **Discord:** Ask in #development channel
- **Examples:** Run `cargo run --example <name>` to see V2 patterns

### Will V1 Knowledge Help?

**Yes for:**

- General Rust development
- Core concepts (VDFS, CAS, file indexing)
- Understanding the problem space

**No for:**

- Specific API calls (completely redesigned)
- Database queries (different ORM)
- File operation patterns (unified model now)
- P2P code (different library)

## Additional Resources

- [Spacedrive Architecture](docs/core/architecture.mdx) - Deep dive into V2 architecture
- [Extension Development](docs/extensions/introduction.mdx) - Build WASM extensions
- [Whitepaper](docs/overview/whitepaper.mdx) - Spacedrive's vision and technical design
- [Discord Community](https://discord.gg/gTaF2Z44f5) - Get help and discuss development

## Credits

This CONTRIBUTING.md file was inspired by the [github/docs CONTRIBUTING.md](https://github.com/github/docs/blob/main/.github/CONTRIBUTING.md) file, and we extend our gratitude to the original author.
