Keyboard shortcuts

Press ← or → to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Contributing

Contributions to Volley are welcome! This page summarizes the development workflow. See the full Contributing Guide for complete details.

Development Setup

git clone https://github.com/volley-streams/volley.git
cd volley
cargo build --workspace
cargo test --workspace --exclude volley-python

System Dependencies

DependencyRequired bymacOSUbuntu
cmakevolley-connector-kafkabrew install cmakeapt install cmake
libcurl4-openssl-devvolley-connector-kafka(included)apt install libcurl4-openssl-dev
protobuf-compilervolley-schedulerbrew install protobufapt install protobuf-compiler

Run volley doctor to check your environment.

Code Style

  • Formatting: cargo fmt --all
  • Linting: cargo clippy --workspace -- -D warnings
  • Tests: cargo test --workspace --exclude volley-python

All warnings are errors in CI (RUSTFLAGS: -Dwarnings).

Submitting Changes

  1. Fork the repository and create a feature branch
  2. Make your changes with clear, focused commits
  3. Ensure cargo fmt, cargo clippy, and cargo test all pass
  4. Open a pull request against main

Project Structure

See Crate Map for a per-crate breakdown of the 17-crate workspace.