Skip to content

Add pre-commit hook configuration #17

@sridharswain

Description

@sridharswain

Description

The project uses black, isort, and mypy for code quality, but there is no .pre-commit-config.yaml file. Contributors must manually remember to run formatting before committing, which can lead to CI failures for style issues.

Suggested Fix

Add a .pre-commit-config.yaml with hooks for:

repos:
  - repo: https://github.com/psf/black
    rev: 25.9.0
    hooks:
      - id: black

  - repo: https://github.com/pycqa/isort
    rev: 7.0.0
    hooks:
      - id: isort

  - repo: https://github.com/pre-commit/mirrors-mypy
    rev: v1.18.1
    hooks:
      - id: mypy
        additional_dependencies: [pydantic]

And document it in CONTRIBUTING.md:

pip install pre-commit
pre-commit install

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions