Contributing

Welcome to contribute to pgmq-sqlalchemy !
This document will guide you through the process of contributing to the project.

How to Contribute

Fork the repository
- Click the Fork button in the upper right corner of the repository page.
Clone the repository
- Clone the repository to your local machine.
```
git clone https://github.com/your-username/pgmq-sqlalchemy.git
```
Create a new branch
- Create a new branch for your changes.
```
git checkout -b feature/your-feature-name
```
Make your changes
- Make your changes to the codebase.
- Add tests for your changes.
- Add documentation if changes are user-facing.
Commit your changes
- Commit your changes with meaningful commit messages.
  - ref: conventional git commit messages
```
git commit -m "feat: your feature description"
```
Push your changes
- Push your changes to your forked repository.
```
git push origin feature/your-feature-name
```
Create a Pull Request
- Create a Pull Request from your forked repository to the develop branch of the original repository.

Install dependencies and ruff pre-commit hooks.

make install

Prerequisites: Docker and Docker Compose installed.

Start development PostgreSQL

make start-db

Stop development PostgreSQL

make stop-db

make help

will show all available commands and their descriptions.

We use pre-commit hook with ruff to automatically lint the codebase before committing.

Run tests in local

make test-local

Run tests for a specific driver

uv run pytest tests --driver=psycopg2

Run tests with a specific database name

uv run pytest tests --driver=psycopg2 --db-name=custom_db

Available drivers:

Run tests in docker

make test-docker

Serve documentation

make doc-serve

Clean documentation build

make doc-clean