Skip to content

Contributing

Contributions are welcome. The full guide - local setup, conventions, and the release flow - lives in CONTRIBUTING.md in the repository.

Terminal window
git clone https://github.com/komaa-com/openai-msteams-bridge
cd openai-msteams-bridge
npm ci
npm test # node:test suites via tsx (no network, no API key needed)
npm run typecheck
npm run build
  • One runtime dependency (ws); everything else is dev-only.
  • The relay core speaks 16 kHz only - all 16k/24k conversion lives in the provider adapter (openai.ts / resample.ts). Keep that boundary.
  • Tests use a fake AgentPort (see test/session.test.ts), so the suite runs without an OpenAI account.
  • Docs live in website/ (this site). Any merged change to website/ redeploys the site automatically.

Document how to connect to the hosted StandIn service and how the bridge behaves on the wire. Do not document the internals of the hosted media bridge - this repository only depends on its published wire contract.