CONTRIBUTING.md

Contributing to erdantic

Report a bug or request a feature

Please file an issue in the issue tracker.

External contributions

Pull requests from external contributors are welcome. However, we ask that any nontrivial changes be discussed with maintainers in an issue first before submitting a pull request.

Local development

[![Pixi Badge][https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/prefix-dev/pixi/main/assets/badge/v0.json&style=flat-square ]][pixi-url]

This project is set up using Pixi for managing environments and Just as a task runner.

Many useful recipes are defined in the justfile. You can run:

just

to see available recipes with brief documentation.

Development environment

Pixi handles the creation and synchronization of the default development environment. You can run commands in the environment like so:

pixi run {some shell command}

You can activate the default environment with

pixi shell

Tests

just test

You can run the tests for a specific Python version with, for example:

just python=3.12 test

To run tests on all supported Python versions, run:

just test-all

All test commands can be passed arguments, e.g.,

just test-all tests/test_against_assets.py

Code quality

We use ruff for linting and formatting, and we use mypy for static type checking. You can run them with the following commands:

just lint
just typecheck