Contributors#

For developers#

  1. Install required tools

    • uv (manually)

    • Taplo (manually)

    • Tox

      uv tool install tox --with tox-uv
      
  2. Clone repository

  3. Initialize developer’s environment

    uv sync
    tox run -e init
    
  4. Run tests

    # run only mypy env
    tox run -e lint-mypy
    
    # run all linting envs (labeled)
    tox run -m lint
    
    # run only ruff formatting env
    tox run -e fmt-py
    
    # run all formatting envs (labeled)
    tox run -m fmt
    
    # list all envs
    tox list
    
    # run all envs
    tox run
    
  5. Contributing — start from opening an issue

Versioning#

SemVer used for versioning. For available versions see the repository tags and releases.