Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
23 lines (18 loc) · 724 Bytes

CONTRIBUTING.md

File metadata and controls

23 lines (18 loc) · 724 Bytes
Raw

Code Style and Linting

Please use The following tools for code style and linting:

  • Black
  • Isort
  • Pylint
  • Mypy

All are configured in the Pyproject.toml file Pre-commit hooks are configured to run these tools automatically on commit.
Please install please run: pre-commit install

Testing

Please use pytest for testing. Run tests with make tests.

Workflow

This repo uses the Trunk Based Development workflow.

Branching

The main branch is main. All development should be done in feature branches and merged into main via pull requests.

Versioning

This repo uses Semantic Versioning.