Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
37 lines (24 loc) · 1 KB

CONTRIBUTING.md

File metadata and controls

37 lines (24 loc) · 1 KB
Raw

Contributing

Thanks for your interest in improving Pipecat Moss! This document captures the workflow for working from the source repository.

Development Environment

  1. Clone the repository and cd into it.

  2. Install dependencies using uv:

    uv sync

  3. Activate the virtual environment so local scripts (examples, tests) run against the checked-out code:

    source .venv/bin/activate

Running Examples

With the environment active you can run the sample pipelines shipped in the examples directory. Please refer to the README for detailed instructions on running the examples.

Code Style

Follow the existing formatting and logging patterns in the codebase.

Submitting Changes

  1. Open a pull request that describes the motivation, highlights user-facing changes, and includes validation steps.
  2. Be responsive to review feedback so the change can merge smoothly.

We appreciate your contributions!