Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
70 lines (50 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

70 lines (50 loc) · 1.64 KB

Contributing to audiolab

Thanks for your interest in contributing! This monorepo contains several audio processing packages for React Native and Expo.

Setup

# 1. Install Git LFS (needed for ONNX models)
./scripts/setup-lfs.sh

# 2. Install dependencies
yarn install

# 3. Build packages
cd apps/playground && yarn build:deps

Development

The playground app is the best way to test changes across all packages:

cd apps/playground
yarn start

For individual package builds:

yarn workspace @siteed/audio-studio build
yarn workspace @siteed/audio-ui build

Testing

./scripts/run_tests.sh

Project Structure

packages/
  audio-studio/          # Core audio recording, analysis, processing
  audio-ui/              # Skia-based visualization components
  react-native-essentia/ # Audio feature extraction (Essentia bindings)
  sherpa-onnx.rn/        # Speech-to-text / text-to-speech
apps/
  playground/            # Full demo app (App Store / Play Store)
  minimal/               # Minimal integration example
  essentia-demo/         # Audio analysis demo
  sherpa-voice/          # Speech recognition demo

Guidelines

  • Keep diffs minimal — smallest change that solves the problem
  • Fix root causes, not symptoms
  • Test on both iOS and Android for UI/navigation changes
  • Use yarn (not npm or npx) for all commands

Docs

License

MIT — contributions are welcome under the same license.