CONTRIBUTING.md

Contributing Guide

Development Setup

Install development dependencies:

uv venv
source .venv/bin/activate
uv sync --group dev

Install pre-commit hooks:

pre-commit install

Development Workflow

Create new branch:

git checkout -b feature/your-feature

Run tests and linting:

task test      # Runs pytest with coverage
task format    # Formats code

Task Commands

All commands are defined in pyproject.toml and can be run using task:

task test      # Run tests
task format    # Format code
task run       # Run main application

Code Style

• Follow PEP 8
• Use type hints
• Write docstrings
• Add tests for new features

Pull Request Process

1. Ensure all tests pass
2. Update documentation if needed
3. Submit PR with clear description
4. Wait for review