Contributing

​

Development Setup

​

Prerequisites

• Python 3.11+
• uv (Recommended for dependency management)

​

Installation

git clone https://github.com/TracingInsights/tif1.git
cd tif1

uv sync --all-extras

uv run prek install

​

Testing Workflow

​

Running Tests

uv run pytest tests/ -v

uv run pytest tests/ -v -m "not integration"

uv run pytest -o addopts='' tests/ -v -n 0 -m integration

uv run pytest -o addopts='' tests/test_benchmarks.py -v -m benchmark --benchmark-only --no-cov -n 0

​

Code Coverage

uv run pytest -o addopts='' tests/ -v -n auto --dist=loadfile --cov=src/tif1 --cov-report=html

​

Code Quality

• Linting & Formatting: The project uses ruff.
  uv run ruff check src/ tests/
  uv run ruff format src/ tests/
  
• Type Checking: The project uses pyright (via ty).
  uv run ty check src/tif1
  
• prek: Run all checks at once.
  uv run prek run --all-files
  

​

Documentation

​

Local Development

1. Install the Mintlify CLI: npm i -g mintlify
2. Run the dev server in the docs directory: mintlify dev

​

Guidelines

• Use Google-style docstrings for all public functions.
• Update mint.json when a new page is added.
• 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.