Contributing

Where to start

1. 1

   Read the project README

   The Develop section covers toolchain, debug runs, and the three-window frontend model. You need Node 20.19+ (22 LTS recommended), Rust stable plus MSVC and the VS Build Tools C++ workload.

2. 2

   Pick a lane

   Rust core (global hotkeys, clipboard simulation, keyring, tray) or React frontend (main, overlay, pill). Docs fixes are first-PR friendly.

3. 3

   Reproduce first

   For behavior changes, reproduce on Windows 10/11 with a provider key before writing code.

Reporting issues

• Include: OS build, Flunkey version, provider, and the hotkey involved
• Paste problems: name the target app (Electron? terminal? browser?) and whether it was elevated
• Never paste API keys, audio, or private dictated text into an issue

Pull requests

• Small, scoped PRs with the behavior change described up front
• Privacy rule is absolute: no new network calls except to user-configured providers, no secrets outside Credential Manager
• Update these docs alongside behavior changes — undocumented features get reverted