Contributing

Thank you for your interest in contributing to this project!

Development Setup

1. Fork the repository on GitHub
2. Clone your fork locally:

git clone https://github.com/NoeFontana/python-template.git
cd python-template

1. Install dependencies:

uv sync --all-groups

1. Set up pre-commit hooks:

   uv run pre-commit install
   

Making Changes

1. Create a new branch for your feature:

git checkout -b feature/your-feature-name

1. Make your changes and write tests

2. Run the test suite:

make check

1. Commit your changes:

git commit -m "Add your feature"

1. Push to your fork and create a pull request

Code Style

This project uses:

• ruff for linting and formatting
• pyright for type checking
• pytest for testing

All checks must pass before merging.