Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
113 lines (78 loc) · 2.59 KB

CONTRIBUTING.md

File metadata and controls

113 lines (78 loc) · 2.59 KB

Contributing

This repository contains a Rust-first workspace of JSON, TOML, YAML, and shared runtime packages for structural PEP 750 templating.

Prerequisites

  • Python 3.14
  • uv
  • git
  • prek for local pre-commit hooks

Install Dependencies

The repository now uses a root uv workspace plus an in-repo Rust workspace.

uv sync --group dev

uv sync installs the shared tstring-bindings workspace package as part of the normal dependency graph. Use maturin develop only when you are working on the bindings package in isolation.

Install prek

The prek project recommends uv tool install prek as a simple installation path:

uv tool install prek

You can also run it without a permanent installation:

uvx prek --version

Source: j178/prek

Install Git Hooks

From the repository root:

prek install

This repository uses a root .pre-commit-config.yaml with local hooks that run:

  • ruff format --check
  • ruff check
  • ty check

The hooks are split by backend so changes usually only trigger the relevant checks.

Run Hooks Manually

To run every configured hook against the whole repository:

prek run --all-files

To run a single hook:

prek run json-backend-checks --all-files
prek run toml-backend-checks --all-files
prek run yaml-backend-checks --all-files

Full Verification Commands

Python Workspace

uv sync --group dev
uv run --group dev ruff format --check .
uv run --group dev ruff check .
uv run --group dev pytest

Conformance manifests and vendored fixture slices live under conformance/. The Python package test suites now include their format-specific conformance cases automatically.

Optional bindings-only workflow:

uv run --group dev maturin develop -F extension-module --manifest-path rust/python-bindings/Cargo.toml

Rust Workspace

cargo fmt --manifest-path rust/Cargo.toml --all --check
cargo clippy --manifest-path rust/Cargo.toml --all-targets --all-features -- -D warnings
PYO3_PYTHON="$PWD/.venv/bin/python3" cargo test --manifest-path rust/Cargo.toml --all

The Rust integration test suites include parser-level conformance checks driven by the same conformance/*/profiles.toml indexes and per-profile manifests used by the Python tests.

Notes

  • Keep repository content in English only.
  • Prefer small, reviewable commits.
  • The authoritative backend behavior is protected by Python end-to-end tests and Rust crate tests, so keep both layers covered when changing runtime behavior.