Skip to content

Latest commit

 

History

History
47 lines (33 loc) · 1.37 KB

File metadata and controls

47 lines (33 loc) · 1.37 KB

Contributing

Thanks for contributing to Wave.

This project is maintained as a personal-use native macOS app. Contributions should prioritize simple, reliable behavior and minimal UI/UX friction.

Local Setup

  1. Open Wave.xcodeproj in Xcode
  2. Select scheme Wave
  3. Press Run — this builds the Debug configuration, which installs as Wave (Debug) and uses bundle ID io.monawwar.wave.debug

If you have the production Wave app installed, quit it first to avoid hotkey and audio tap conflicts.

What To Focus On

  • Dictation reliability (hotkey -> record -> transcribe -> paste)
  • Lightweight native UX
  • Safe single-instance behavior
  • Clear onboarding and settings behavior

Using AI To Build Features

AI-assisted contribution is welcome. If you use AI tools:

  1. Keep prompts specific to this codebase and file paths.
  2. Ask AI for incremental changes, not large rewrites.
  3. Verify all generated code manually before committing.
  4. Build and run the app after changes.
  5. Confirm no regressions in:
    • global shortcut capture
    • overlay status behavior
    • text paste flow
    • onboarding/state persistence

When proposing AI-generated changes, include:

  • what files changed
  • what behavior changed
  • how you validated locally

PR/Change Notes

When submitting changes, keep notes concise:

  • Problem being solved
  • Implementation summary
  • Validation steps run