Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
82 lines (58 loc) · 3.19 KB

CONTRIBUTING.md

File metadata and controls

82 lines (58 loc) · 3.19 KB
Raw

Contributing to StemDeck

Thanks for your interest in StemDeck - free, local stem separation for musicians. Contributions of all kinds are welcome, whether you write code or not.

By participating you agree to follow our Code of Conduct.

Ways to contribute

  • Report a bug - open a Bug report. Include your OS, the StemDeck version (Help icon -> About), and clear steps to reproduce.
  • Suggest a feature - open a Feature request.
  • Improve the docs - fixes and clarifications to the README or these guides are always useful.
  • Write code - bug fixes and features. For anything large, please open an issue or a Discussion first so we can agree on the approach before you invest time.
  • Found a security issue? Do not open a public issue - see SECURITY.md.

Project layout

  • app/ - FastAPI backend (the audio pipeline, job registry, and HTTP API).
  • static/ - the web UI: plain ES-module JavaScript, HTML, and CSS. No build step, no bundler.
  • desktop/ - the Tauri v2 desktop shell (Rust) that wraps the backend + UI.
  • scripts/ - packaging scripts (macOS app/dmg, Windows portable, runtime pack).
  • tests/ - the pytest suite for the backend.

Development setup

You need uv and ffmpeg on your PATH.

uv sync --python 3.12        # install the Python environment
./run.sh start               # start the backend at http://localhost:8000

Other helpers:

./run.sh restart             # restart after backend changes
./run.sh stop                # stop the server
./run.sh status              # is it running?

Open http://localhost:8000 in your browser to use the app. Frontend changes are picked up on reload (no build step).

Before you open a pull request

Please run the same checks CI runs:

uv run ruff check app/ tests/        # lint
uv run ruff format --check app/ tests/   # formatting
node --check static/js/<changed>.js  # syntax-check any JS you touched
uv run pytest tests/ -q              # backend tests

For Rust changes in desktop/, also run cargo fmt --check and cargo clippy -- -D warnings.

Pull request guidelines

  • Branch off main.
  • Use Conventional Commits for messages (feat:, fix:, docs:, refactor:, test:, chore:, ci:).
  • Open the PR as a draft until it is ready for review.
  • Keep PRs focused - one logical change per PR makes review faster.
  • Describe what changed and why, and how you tested it.

Tests

New API endpoints and pipeline stages should come with tests under tests/. The suite uses pytest with httpx.AsyncClient; see the existing tests/test_*.py files for patterns.

License

StemDeck is licensed under the Apache License 2.0. By contributing, you agree that your contributions are licensed under the same terms.

Questions

Open a Discussion or join the Discord. Thanks for helping make StemDeck better.