Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (29 loc) · 2.24 KB

CONTRIBUTING.md

File metadata and controls

47 lines (29 loc) · 2.24 KB
Raw

Contributing

Hey, thanks for stopping by. Quick rundown so you know what to expect.

Filing a bug

Use the bug report template. The more concrete the better: InstantClone version, Windows version, OBS version, what you did, what you expected, what actually happened. Logs from the dashboard's Logs tab help a ton (redact stream keys if any leak in).

Asking a question

Open a Discussion. Issues are for things that need fixing.

Sending a PR

  • One change per PR makes review easier.
  • Before pushing: cargo fmt, cargo clippy --release clean, cargo test --release showing 154 passed; 0 failed (or higher if the suite has grown since this line was last touched).
  • A line on how you tested goes a long way. "Tested with OBS 30.2 against a local RTMP sink for ~5 min with a 15 s armed delay" beats "works on my machine".
  • For new features, open an issue first so we don't duplicate effort.

Stuff I'd love help with

  • Cross-platform support (macOS, Linux). The code is mostly portable; tray.rs, portcheck.rs, and sysstat.rs have Windows-specific paths that need parallel implementations.
  • New overlay presets + Studio widgets. Built-in overlays are the PRESETS in web/overlay-runtime.js (the dashboard seeds them on first run); new widgets/animations live in the same file. A hand-written .html dropped into overlays/ is still served as-is.
  • Real-world bug reports from streaming with the proxy in the loop.

Probably not

  • Pure-refactor PRs with no behaviour change. The codebase is small; churn costs more than it earns.
  • Wide-net dep additions. Runtime stays at tokio + bytes + ureq (+ windows-sys on Windows) unless there's a strong reason.

Build

Rust 1.74+ stable.

cargo build --release
cargo test --release
.\target\release\instantclone.exe

Be decent

Participation here is covered by the Code of Conduct. Short version: be respectful, no harassment.

One last thing

I'm one person doing this on weekends. If a PR or issue sits for a week or two without a reply, a friendly bump is welcome.