Contributing to PgDoorman

Thank you for your interest in contributing to PgDoorman! This guide will help you set up your development environment and understand the contribution process.

Getting Started

Prerequisites

Before you begin, make sure you have the following installed:

Rust (latest stable version)
Git
Docker (optional, for running tests)
Make (optional, for running test scripts)

Setting Up Your Development Environment

Fork the repository on GitHub

Clone your fork:

git clone https://github.com/YOUR-USERNAME/pg_doorman.git
cd pg_doorman

Add the upstream repository:

git remote add upstream https://github.com/ozontech/pg_doorman.git

Local Development

Build the project:
```
cargo build
```
Build for performance testing:
```
cargo build --release
```
Configure PgDoorman:
Copy the example configuration: cp pg_doorman.toml.example pg_doorman.toml
Adjust the configuration in pg_doorman.toml to match your setup
Run PgDoorman:
```
cargo run --release
```
Run tests:
```
cargo test
```
Run integration tests with Docker:
```
make docker-compose-test-all
```

Contribution Guidelines

Code Style

Follow the Rust style guidelines
Use meaningful variable and function names
Add comments for complex logic
Write tests for new functionality

Pull Request Process

Create a new branch for your feature or bugfix
Make your changes and commit them with clear, descriptive messages
Write or update tests as necessary
Update documentation to reflect any changes
Submit a pull request to the main repository
Address any feedback from code reviews

Reporting Issues

If you find a bug or have a feature request, please create an issue on the GitHub repository with:

A clear, descriptive title
A detailed description of the issue or feature
Steps to reproduce (for bugs)
Expected and actual behavior (for bugs)

Getting Help

If you need help with your contribution, you can:

Ask questions in the GitHub issues
Reach out to the maintainers

Thank you for contributing to PgDoorman!