Contributing

Thank you for considering contributing to auto-print! This document provides guidelines for contributing to the project.

Development Setup

1. Clone the repository:

   git clone https://github.com/philipp-horstenkamp/auto-print.git
   cd auto-print
   

2. Install development dependencies:

   poetry install
   

3. Set up pre-commit hooks:

   pre-commit install
   

Code Style

This project uses:

• for linting and formatting

• for type checking

You can run these tools using pre-commit:

pre-commit run --all-files

Testing

Run tests using pytest:

poetry run pytest

Documentation

To build the documentation:

cd docs
make html

Pull Request Process

1. Create a new branch for your feature or bugfix

2. Make your changes

3. Run tests and linting

4. Submit a pull request

5. Ensure CI checks pass