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 usespytest, with xdist for parallel execution.
Running Tests
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:- Install the Mintlify CLI:
npm i -g mint - Run the dev server in the
docsdirectory:mint dev
Guidelines
- Use Google-style docstrings for all public functions.
- Update
docs/docs.jsonwhen a new page is added. - Follow the house style in
docs/style-ste100.md. Check a page withpython3 tools/ste_check.py docs/<page>.mdx. - Use Mintlify components (
<Steps>,<Card>,<CodeGroup>) to structure the pages.
Pull Request Process
- Create a branch:
git checkout -b feat/your-awesome-feature - Implement & Test: Make sure that the coverage does not drop.
- Commit: Use Conventional Commits, for example
feat:,fix:,docs:,perf:. - Push & Open PR: Describe the changes and the reason for them.