Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
73 lines (55 loc) · 2.2 KB

CONTRIBUTING.md

File metadata and controls

73 lines (55 loc) · 2.2 KB

Contributing to mq-bridge

Thank you for your interest in contributing to mq-bridge! We welcome bug reports, feature requests, documentation improvements, and code contributions.

Getting Started

  1. Fork the repository and clone your fork locally.
  2. Install Rust (stable, via rustup).
  3. Install required dependencies for optional features (Kafka, NATS, AMQP, etc.) as needed. The test folder also has Docker-Compose files for the specific brokers, so you don't need to install them natively.
  4. Run tests to verify your environment: 
    cargo test --features full

Code Style

  • Run cargo fmt --all before submitting a PR.
  • Ensure code passes cargo clippy --all-features -- -D warnings.
  • Follow idiomatic Rust and existing code conventions.

Making Changes

  • New endpoints or middleware:
    • Add new files in src/endpoints/ or src/middleware/.
    • Update factory functions in mod.rs as needed.
    • Add configuration models to src/models.rs.
  • Tests:
    • Add or update unit tests in the relevant module.
    • Add integration tests in tests/integration/ if applicable.
  • Documentation:
    • Update README.md and add doc comments for public APIs.

Running Tests

  • Unit tests: 
    cargo test
  • Integration tests: 
    cargo test --test integration_test --features full
  • Performance tests: 
    cargo bench
  • Memory tests: 
    cargo test --test memory_test

Some integration tests require Docker services. See tests/integration/docker-compose/ for setup.

Submitting a Pull Request

  1. Create a branch for your change.
  2. Write clear commit messages.
  3. Open a pull request against the main branch.
  4. Describe your changes and reference any related issues.
  5. Ensure all tests pass and CI checks succeed.

Reporting Issues

  • Use GitHub Issues for bugs, enhancements, or questions.
  • Provide as much detail as possible (logs, configs, steps to reproduce).

Code of Conduct

Be respectful and inclusive. See CODE_OF_CONDUCT.md if present.

Thank you for helping make mq-bridge better!