Contributing

Contributions to the engine (mq-bridge) — bug reports, feature requests, docs, and code — are welcome. The engine repo holds the authoritative CONTRIBUTING.md; this page is a short orientation.

Getting started

1. Fork and clone the engine repo.
2. Install Rust (stable, via rustup).
3. The tests/ folder ships Docker-Compose files for each broker, so you don’t need to install Kafka/NATS/AMQP/etc. natively.
4. Verify your environment: cargo test -p mq-bridge-app --features full.

Code style

• cargo fmt --all before submitting a PR.
• cargo clippy -p mq-bridge-app --all-targets -- -D warnings must pass (what app.yml runs). Not --all-features: it turns on the engine’s link-dynamic, which needs a system librdkafka via pkg-config.
• Follow idiomatic Rust and existing conventions.

Adding an endpoint or middleware

• Add files under src/endpoints/ or src/middleware/.
• Update the factory functions in the relevant mod.rs.
• Add configuration models to src/models.rs.
• Add/adjust unit tests in the module, and integration tests under tests/integration/ where applicable.
• Keep the REFERENCE.md snippets valid — they are parsed by tests/reference_docs_test.rs.

Building this book

The documentation lives in the repository under docs/book/. To build it locally, see docs/book/README.md.

See also

• Engine CONTRIBUTING.md — the full, authoritative guide.
• Custom endpoints and Custom middleware — extend without forking.