Contributing

Thank you for your interest in contributing to matchminer-ai.

Contributions are welcome through GitHub pull requests. Please fork the repository and open a pull request from your fork.

Local Setup

Clone your fork and move into the repository root:

git clone https://github.com/<your-username>/matchminer-ai-inference.git
cd matchminer-ai-inference

We recommend using uv to create the Python environment and install the package. Create and activate a Python 3.12 virtual environment:

uv venv --python 3.12
source .venv/bin/activate

Install the package in editable mode with development dependencies:

uv pip install -e ".[dev]"

Install the pre-commit hooks:

pre-commit install

The pre-commit hooks run formatting, linting, type-checking, and sensitive data checks before commits.

Before You Open a Pull Request

Run the relevant tests from the repository root:

pytest

Warning

Do not include PHI, PII, credentials, secrets, generated cache files, or model outputs containing sensitive data.

Pull Request Checks

GitHub Actions runs automated checks on pushes and pull requests. These checks install the package, run the pre-commit hooks, scan for sensitive data, and run the test suite. These checks must pass before merge.