@vdoninja/sdk/CONTRIBUTING.md

AI-friendly P2P communication SDK for audio, video, and data. Includes WHIP/WHEP clients for publishing to Twitch, Meshcast, Cloudflare Stream

# Contributing to VDO.Ninja SDK

Thank you for considering a contribution! This document outlines how to get
started and what to expect.

## Quick Start

```bash
# Clone the repo
git clone https://github.com/steveseguin/ninjasdk.git
cd ninjasdk

# Install dependencies
npm install

# Install a WebRTC implementation for Node.js tests
npm install @roamhq/wrtc

# Run tests
npm test

# Build minified SDK
npm run build
```

## Pull Request Guidelines

1. **PRs are strongly preferred over private forks.**  
   Contributing changes back helps keep the SDK and API unified and makes fixes
   available to everyone using the official distribution.

2. **Changes to MPL-covered SDK core files remain MPL-2.0 when distributed.**
   Separate application files, wrappers, and integrations may use other licenses.

3. **Keep PRs focused.** One feature or fix per PR makes review easier.

4. **Include tests if applicable.** The test suite is in `run-all-tests.js`.

5. **Run `npm test` and `npm run build` before submitting** to make sure
   everything passes and the minified output is up to date.

## Contributor License Agreement (CLA)

By submitting a pull request, you agree to the [CLA](CLA.md). In short, you
assign your contribution rights to the maintainer so that:

- The project can be enforced, relicensed, and commercially licensed consistently.
- Future licensing decisions can be made consistently without needing to contact
  every contributor.

If you have concerns about the CLA, please open an issue before contributing.

## Code Style

- Use 4-space indentation.
- Keep lines under 120 characters where practical.
- Use descriptive variable/function names.
- Add JSDoc comments for public APIs.
- No trailing whitespace.

## Reporting Issues

- Search existing issues before opening a new one.
- Include steps to reproduce, expected vs. actual behavior, and environment
  details (browser/Node version, OS, etc.).

## Questions?

Open an issue or join the [Discord community](https://discord.vdo.ninja).

---

Thanks for helping make VDO.Ninja SDK better!