CONTRIBUTING.md

Contributing Guide

This guide should help you get started with contributing to the project. It will cover things such as getting your development environment setup and how to run the tests.

Development Environment

This project uses hatch as its project management tool.

To enter the development environment (it will be created automatically) run:

$ hatch shell

Once in this environment you can run condax commands to see how your current code behaves. If you don't run hatch shell, you should prefix all commands mentioned below with hatch run.

Running Tests

To run the tests you can use pytest.

$ pytest

Code Formatting

This project uses black for code formatting and isort to order imports. To format your code run:

$ black .
$ isort .

Type Checking

This project uses mypy for type checking. To run the type checker run:

$ mypy .

Running Formatting and Type Checking at once

To run all of the above tools at once, you can use pre-commit.

$ pre-commit run --all-files

To configure it to run automatically when commiting code with git, run:

$ pre-commit install

If you don't do any of this, it will be run automatically anyways when you open a pull request.