Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
173 lines (116 loc) · 4.05 KB

CONTRIBUTING.md

File metadata and controls

173 lines (116 loc) · 4.05 KB

Contributing to StreamKit

Quick Start

git clone https://github.com/streamer45/streamkit.git
cd streamkit
just build-ui   # build the embedded web UI (required before compiling the server)
just dev        # starts backend + frontend with hot reload

Prerequisites: Rust 1.92+, Bun 1.3+, Just

Run just --list to see all available commands.

Prerequisites (detailed)

System packages (Ubuntu/Debian)

sudo apt install libopus-dev cmake pkg-config libssl-dev

Rust toolchain

The repo pins the toolchain via rust-toolchain.toml (currently Rust 1.92). Install Rust if you haven't already:

curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

Bun

curl -fsSL https://bun.sh/install | bash

Just (task runner)

cargo install just

sccache (build cache — recommended)

sccache caches compiled crate artifacts by input hash, making rebuilds significantly faster. CI uses it automatically; for local development:

cargo install sccache --locked
export RUSTC_WRAPPER=sccache   # add to your shell profile

Note: You can also uncomment the rustc-wrapper line in .cargo/config.toml to enable it repo-wide instead of via environment variable.

cargo-sweep (build cleanup — optional)

Used by just sweep to prune stale build artifacts without a full cargo clean:

cargo install cargo-sweep --locked

Linting tools

Required by just lint:

cargo install cargo-deny
pip3 install --user reuse   # note: the apt version is too old

Development mode

Required by just dev:

cargo install cargo-watch

Native plugin development (optional)

Building ML plugins (e.g. whisper, sensevoice) requires additional dependencies:

sudo apt install clang libclang-dev

Making Changes

  1. Create a branch: git checkout -b feat/my-feature or fix/my-bug
  2. Make your changes
  3. Run just test and just lint
  4. Commit and push
  5. Open a PR

Commits

All commits must be signed off to certify you have the right to submit the code (DCO):

git commit -s -m "feat(nodes): add MP3 decoder"

This adds a Signed-off-by: Your Name <email> line. The DCO check will fail on PRs without it.

We use Conventional Commits. Format:

type(scope): description

Types: feat, fix, docs, refactor, perf, test, chore, ci, build

Scopes: core, api, engine, nodes, server, client, ui, plugins

Examples:

feat(nodes): add MP3 decoder
fix(engine): prevent panic on empty input
docs: update README

There's a warning-only commit hook - it won't block you, just nudges you toward the convention.

Code Style

Rust:

  • cargo fmt for formatting
  • Fix all cargo clippy warnings
  • Use Result types, avoid unwrap() in production code
  • Add doc comments for public APIs

TypeScript:

  • ESLint handles formatting
  • Avoid any - use proper types
  • Functional components with hooks
  • Zustand for global state, React Query for server state

All files need SPDX license headers:

// SPDX-FileCopyrightText: © 2025 StreamKit Contributors
//
// SPDX-License-Identifier: MPL-2.0

Pull Requests

  • Keep PRs focused (one feature/fix per PR)
  • Add tests for new functionality
  • Update docs if behavior changes
  • Use conventional commit format for PR titles (they become squash-merge commits)
  • CI must pass: tests, formatting, clippy, TypeScript compilation, license headers

Plugins

Native plugins (fast, no sandbox): See examples/plugins/gain-native/

WASM plugins (sandboxed, cross-language): See examples/plugins/gain-wasm-rust/ or gain-wasm-go/

License

Contributions are licensed under MPL-2.0.

Help