Contributing
Start with reproducible issues, clear scope and verifiable changes.
What to contribute
Improve docs, accessibility and UI; fix connection or synchronization issues; add tests or providers. Discuss larger product changes in an issue first. Small fixes can go directly to a PR.
The open-source repository is MIT-licensed. Contribute only code you have the right to share. Never include private third-party source, credentials or real user sessions.
Local development
Run and check Go, native UI, Web and Workers.
Add a provider
Extend agents without duplicating device or connection logic.
Maintain documentation
Work with MDX, sidebar metadata and verifiable examples.
Commits and pull requests
- Keep each PR focused on one explainable outcome; avoid unrelated refactors.
- Describe the result in commit messages, such as
Fix reconnect snapshot gaps, rather thanupdate. - Describe triggers, resulting behavior, validation and limitations in the PR.
- Include desktop/narrow-screen evidence for UI; cover direct, fallback and reconnect paths for networking; update both ends for protocol changes.
- Use isolated fixtures and temporary databases. Do not modify a contributor's real agent sessions.
- Keep build outputs, databases, signing keys, OAuth tokens and local configuration out of Git.
Checks and releases
Use gofmt for Go and repository Prettier for TypeScript/MDX. Run relevant tests and required CI checks. A successful build alone is not device validation.
Main CI artifacts are developer previews. Maintainers publish Releases through version tags; never move a published tag. See Local development.