Skip to main content
Synchronize all development groups and extras with uv sync --all-groups --all-extras. Required local checks are:
Focused tests use -m unit, -m property, -m integration, -m conformance, or -m distribution. The unfiltered suite remains the authoritative collection gate.

How to contribute

TypeWall uses a fork-based pull request workflow against MyGenX/TypeWall.
1

Fork the repository

Fork MyGenX/TypeWall to your own account and clone your fork (replace YOUR-USERNAME):
2

Work on a branch

Create a focused feature branch, make your changes, and run the local checks above until they pass:
3

Open a pull request

Push the branch to your fork and open a PR against MyGenX/TypeWall:main:
4

Get it merged

Address review feedback and keep the branch up to date with upstream/main. A maintainer merges the PR once checks pass and the review is approved.

Documentation

Documentation is a self-contained Mintlify project under docs/. Install its toolchain once, then preview the site and check for broken links:
Published documentation is deployed through the Mintlify platform via its GitHub integration, which manages versioning automatically. There is no manual deploy step in this repository.