Skip to content

Contributing

Contributions to gp-retouch are welcome! Here's how you can help:

Set Up Development Environment

  1. Clone the repository:

    git clone https://github.com/emilioMaddalena/gp-retouch.git
    cd gp-retouch
    

  2. Install in development mode:

    pip install -e .
    

  3. Install development dependencies:

    pip install pytest ruff
    

Code Style

This project uses Ruff for linting. To check your code:

ruff check .

Running Tests

Tests are run using pytest:

pytest

Pull Request Process

  1. Create a new branch for your feature or bugfix
  2. Make your changes
  3. Run tests and linter
  4. Submit a pull request