Skip to content

Contributing

The IMMERSE platform doesn't accept external contributions yet. This file describes what's planned.

Today (v0.1.0 — early access)

The codebase is closed to external contributions. Source is shared with friendly testers and partners under direct relationships, but pull requests, patches, or submissions are not accepted.

If you're a tester or partner and have a fix or improvement to suggest: - Email support@immersecontrol.com with a description and a code diff - We'll review, integrate if appropriate, and credit you

Future

After v1.0, we may open contributions to specific areas:

Likely accepted areas

  • Bug fixes with clear reproduction steps and tests
  • Documentation improvements
  • New cue types via a public extension API (when one exists)
  • Translations (when localization is added)
  • New Node implementations (e.g. ESP32-based GPIO node) targeting the documented HTTP protocol

Unlikely to be accepted

  • Core architecture changes (Studio/Runtime/Node split)
  • Schema format changes (without prior coordination)
  • Major dependency changes (e.g. moving Studio to a framework)
  • Security-sensitive code without prior discussion

Code style

If you submit a patch: - Follow the conventions in for-developers/README.md (vanilla JS, 2-space indent, single quotes) - Add tests for new behavior - Update CHANGELOG entries - Don't bundle unrelated changes — one PR, one concern

Communication

  • Bugs / feature requests: support@immersecontrol.com
  • Security disclosures: security@immersecontrol.com (planned; for now use support@)
  • Architecture discussions: in person or on a call with the core team

There's no public issue tracker, mailing list, or chat in v0.1.0. As the platform grows, we'll set those up.