Contributing

We welcome contributions to Paperap!

Development Setup

  1. Clone the repository:

    git clone https://github.com/Paperap/Paperap.git
    cd Paperap
    
  2. Install development dependencies:

    pip install -e ".[dev]"
    
  3. Set up pre-commit hooks:

    pre-commit install
    

Running Tests

Run tests using pytest:

pytest

Code Style

This project uses:

  • Black for code formatting

  • Ruff for linting

  • MyPy for type checking

You can run these tools with:

black src tests
ruff check src tests
mypy src