Development

Resources for contributors and developers working on pgqrs.

• Contributing

  ---

  How to contribute to pgqrs development.

  Contributing Guide

• Testing

  ---

  Run and write tests for pgqrs.

  Testing Guide

• Release Process

  ---

  How releases are managed and published.

  Release Process

Quick Start for Contributors

Prerequisites

• Rust 1.70+
• PostgreSQL 14+
• Docker (for testing)

Clone and Build

git clone https://github.com/vrajat/pgqrs.git
cd pgqrs

# Build all crates
cargo build

# Run tests (requires PostgreSQL)
cargo test

Project Structure

pgqrs/
├── crates/
│   └── pgqrs/           # Main Rust library and CLI
│       ├── src/
│       │   ├── lib.rs   # Library exports
│       │   ├── admin.rs # Admin API
│       │   ├── producer.rs
│       │   ├── consumer.rs
│       │   ├── config.rs
│       │   └── worker/  # Worker trait and types
│       ├── examples/
│       └── tests/
├── py-pgqrs/            # Python bindings (PyO3)
│   ├── src/lib.rs
│   └── tests/
└── docs/                # Documentation

Development Workflow

1. Create a branch from main
2. Make changes and add tests
3. Run tests locally
4. Submit a PR with clear description
5. Address review feedback

Getting Help

• GitHub Issues - Bug reports and feature requests
• GitHub Discussions - Questions and ideas