Robotics Runtime Contracts Quality Declaration

This document applies the guidelines in REP-2004 to the robotics-runtime-contracts Python package. The package is not a ROS package, but REP-2004 provides a useful, recognizable maturity rubric.

The package claims Quality Level 4. It is a pre-1.0 package and does not claim the stable-version, platform breadth, coverage policy, or peer-reviewed quality registration required for Levels 1 through 3.

Version Policy

The Python distribution follows Semantic Versioning during its pre-1.0 phase. The canonical pre-1.0 contract set and release policy are documented in COMPATIBILITY.md. Tagged artifacts are immutable; schema digests for packaged bytes are available through the public API.

The public Python API is the set exported by robotics_runtime_contracts.__all__. Internal modules and underscored symbols are not a stable API.

Change Control

Repository policy requires reviewable changes, CI on pushes and pull requests, positive and negative contract fixtures, consumer-impact analysis, and migration notes for breaking changes. The repository does not claim an independently audited peer-review or contributor-origin process.

Documentation

Feature and API entry points are documented in README.md. Compatibility rules are in COMPATIBILITY.md, architecture decisions are in docs/decisions, and supply-chain claims are in SUPPLY_CHAIN.md.

The package is licensed under the MIT License. Copyright and author attribution are recorded in that license and repository history.

Testing and Static Analysis

CI performs:

  • JSON Schema Draft 2020-12 metaschema checks;

  • positive, negative, semantic, qualification-link, and consumer-example tests;

  • Ruff linting and formatting;

  • strict mypy analysis of the typed package;

  • structural and semantic compatibility checks against the last release.

The release workflow builds the wheel and source distribution and installs each into a clean CPython 3.12 environment before publication.

These checks exceed the minimum Level 4 requirements. The project does not yet publish or enforce a coverage threshold and therefore does not claim a higher quality level.

Dependencies

The runtime dependencies are jsonschema with non-GPL format-validation extras, referencing and PyYAML. They are constrained in pyproject.toml and resolved in the workspace lockfile. ADR 0010 records the narrow resolver adapter and upgrade regressions. The package has no runtime ROS dependency. Consumer-example tests use the current checkout; they do not certify compatibility with released harness/infra combinations.

Platform Support

The CI validation matrix targets CPython 3.12, 3.13 and 3.14 on Ubuntu 24.04 x86-64 and runs the test suite for each interpreter. Distribution builds and installation checks run in the release workflow on CPython 3.12 only. The declared support range is >=3.12,<3.15; .python-version selects its minimum for local development. A matrix configuration is not itself evidence of a successful hosted run. The pure-Python wheel does not establish support for additional operating systems or architectures.

Security

The vulnerability disclosure process and response target are documented in SECURITY.md. Validation performs no schema network fetches. Release artifacts receive GitHub build-provenance attestations as documented in SUPPLY_CHAIN.md.

Peer Review

This Quality Level 4 claim has not been registered in a centralized REP-2004 package list and has not undergone an external REP-2004 assessment.