Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
62 lines (45 loc) · 1.58 KB

CONTRIBUTING.md

File metadata and controls

62 lines (45 loc) · 1.58 KB
Raw

Contributing to FineTune

Thank you for your interest in contributing to FineTune!

Building from Source

  1. Clone the repository:

    git clone https://github.com/ronitsingh10/FineTune.git
cd FineTune

  2. Open in Xcode:

    open FineTune.xcodeproj

  3. Set your development team in Xcode:

    • Select the FineTune target
    • Go to Signing & Capabilities
    • Select your team from the dropdown

  4. Build and run (Cmd+R)

Submitting Issues

  • Check existing issues before creating a new one
  • Include macOS version and steps to reproduce
  • For audio issues, include which apps were playing audio

Pull Requests

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/my-feature)
  3. Make your changes
  4. Test with multiple audio sources and output devices
  5. Commit your changes
  6. Push to your fork and open a pull request

Code Style

  • Follow existing patterns in the codebase
  • Use @Observable and @MainActor for state management
  • Audio callback code must be real-time safe (no allocations, locks, or ObjC)
  • Views: props first, callbacks for mutations, @State only for local UI state

Audio Callback Guidelines

Code running in processAudio() must be real-time safe:

  • No memory allocations (malloc, new, Array.append)
  • No locks (NSLock, DispatchSemaphore, os_unfair_lock)
  • No Objective-C messaging
  • No file I/O or logging
  • No Swift print() statements

Testing

Before submitting:

  • Test with 2+ output devices
  • Test device hot-plug (disconnect during playback)
  • Test with 5+ apps playing audio simultaneously