Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
118 lines (80 loc) · 2 KB

CONTRIBUTING.md

File metadata and controls

118 lines (80 loc) · 2 KB

Contributing

Thank you for your interest in contributing to Vibe Haptic!

Development Setup

Prerequisites

  • Bun v1.0+ — JavaScript runtime and package manager
  • Rust toolchain — for building the native module
  • Xcode Command Line Tools — required for macOS development
# Install Rust if needed
curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# Install Xcode CLI tools if needed
xcode-select --install

Building

# Install dependencies
bun install

# Build everything (native module + TypeScript)
bun run build

# Build native module only
bun run build:native

Running Locally

bun run dev:claude
bun run dev:opencode

Running Tests

bun test

Type Checking

bun run typecheck

Linting & Formatting

This project uses Biome for code quality.

# Check for issues
bun run lint

# Auto-fix issues
bun run lint:fix

Testing with Agents

Claude Code

Load the plugin directly from your local directory:

claude --plugin-dir ./

OpenCode

Reference the local build in your opencode.jsonc:

{
  "plugins": [
    "file:///absolute/path/to/vibe-haptic/dist/index.js"
  ]
}

Testing Haptic Patterns

Use the built-in CLI to test patterns without running a full agent:

# Play a named pattern
bun run play dopamine

# Play a custom beat
bun run play "66 44 66"

Native Module

The native module wraps macOS MultitouchSupport.framework using napi-rs:

// Trigger haptic feedback
MTActuatorActuate(actuator, actuation_id, 0, 0.0, intensity);
  • actuation_id: 3 (minimal) to 6 (strong)
  • intensity: 0.0 to 2.0

The framework is private but stable across macOS versions.

Pull Request Guidelines

  1. Keep changes focused — one feature or fix per PR
  2. Add tests for new functionality
  3. Ensure all checks pass (bun test, bun run typecheck, bun run lint)
  4. Update documentation if needed