Skip to main content
This guide explains how to set up a development environment and how to submit changes to tif1.

Development Setup

Prerequisites

  • Python 3.11+ (CI tests 3.11 through 3.15)
  • uv (Recommended for dependency management)

Installation

1

Clone the repository

2

Install dependencies

Use uv to create a virtual environment and install all development extras.
3

Install git hooks with prek

Enable the lint and format checks before every commit and push.

Testing Workflow

The test suite uses pytest, with xdist for parallel execution.

Running Tests

An autouse fixture blocks real network sockets. A test that must reach the network needs the integration, compliance_online, or benchmark marker. Tests under tests/integration/ are exempt.

Code Coverage

Run the tests with coverage reporting. CI fails when the total coverage is below 80%.

Code Quality

Make sure that the code passes all quality checks before a pull request is submitted.
  • Linting & Formatting: The project uses ruff.
  • Type Checking: The project uses ty.
  • prek: Run the git hook checks (ruff, ruff format, and file checks) on all files. CI runs the same command.

Documentation

The documentation is built with Mintlify.

Local Development

To preview the documentation locally:
  1. Install the Mintlify CLI: npm i -g mint
  2. Run the dev server in the docs directory: mint dev

Guidelines

  • Use Google-style docstrings for all public functions.
  • Update docs/docs.json when a new page is added.
  • Follow the house style in docs/style-ste100.md. Check a page with python3 tools/ste_check.py docs/<page>.mdx.
  • Use Mintlify components (<Steps>, <Card>, <CodeGroup>) to structure the pages.

Pull Request Process

  1. Create a branch: git checkout -b feat/your-awesome-feature
  2. Implement & Test: Make sure that the coverage does not drop.
  3. Commit: Use Conventional Commits, for example feat:, fix:, docs:, perf:.
  4. Push & Open PR: Describe the changes and the reason for them.
Check CHANGELOG.md and add a summary of the changes there as well.
Last modified on October 15, 2026