Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
112 lines (76 loc) · 2.68 KB

CONTRIBUTING.md

File metadata and controls

112 lines (76 loc) · 2.68 KB

Contributing to Conclave

This guide defines how to contribute safely and efficiently to the Conclave monorepo.

Scope

This repository includes:

  • web client (apps/web)
  • mobile client (apps/mobile)
  • SFU service (packages/sfu)
  • in-meeting apps runtime SDK (packages/apps-sdk)
  • optional shared browser service (packages/shared-browser)

Getting Started

  1. Fork the repository.
  2. Clone your fork.
  3. Create a feature branch.
  4. Install dependencies:
pnpm install

Mobile has separate install flow:

pnpm -C apps/mobile install

Development Commands

Web:

pnpm -C apps/web run dev

SFU:

pnpm -C packages/sfu run dev

Mobile:

pnpm -C apps/mobile run start

Shared browser service (optional):

pnpm -C packages/shared-browser run dev

Apps SDK Contributions

If your PR touches in-meeting apps or app runtime behavior, use the Apps SDK docs first:

Useful commands:

pnpm -C packages/apps-sdk run new:app <id>
pnpm -C packages/apps-sdk run check:apps
pnpm -C packages/apps-sdk run check:apps:fix

Pull Request Guidelines

  • Keep PRs focused and scoped.
  • Explain what changed, why, and impacted surfaces (web/mobile/sfu/apps-sdk).
  • Link related issues (Fixes #<id> when applicable).
  • Include screenshots/video for meaningful UI changes.
  • Update docs when behavior, workflows, or public APIs change.

Quality Expectations

Before requesting review:

  • verify changed apps/services start and run in your local environment
  • run relevant checks for touched packages
  • avoid unrelated refactors in the same PR
  • call out known limitations or follow-up work explicitly

Opening Issues

For bugs, include:

  • reproduction steps
  • expected behavior vs actual behavior
  • environment details (OS, browser/device, versions)
  • logs or screenshots when relevant

For feature requests, include:

  • user problem
  • proposed solution
  • alternatives considered
  • expected UX impact

Security issues should not be disclosed publicly. Report privately via the project contact in CODE_OF_CONDUCT.md.

Community Standards

Participation implies agreement with CODE_OF_CONDUCT.md.