generated from cmudrc/python-template
-
Notifications
You must be signed in to change notification settings - Fork 0
Open
Labels
priority:highHigh impact or urgent release workHigh impact or urgent release workscope:adaptersAdapter integration layersAdapter integration layersscope:study-schemaStudy schema and validation contractsStudy schema and validation contractsstatus:readyReady to startReady to starttype:integrationIntegration with external repos or toolsIntegration with external repos or toolstype:testingTest coverage, fixtures, or validation workTest coverage, fixtures, or validation work
Milestone
Description
Summary
Turn the published artifact contract into an executable guarantee by enforcing schema-version fields and validating exported study outputs in tests.
Why
- The public contract page is only trustworthy if exported artifacts are checked against it.
design-research-analysisand umbrella integration work need stable machine-validated fields.- Versioned validation will make future schema evolution safer.
Proposed work
- Add explicit schema or version markers to exported artifacts where required by the public contract.
- Add validation helpers or fixtures for
study.yaml,manifest.json,conditions.csv,runs.csv,events.csv, andevaluations.csv. - Add regression tests that fail on missing required fields or unsupported version changes.
- Document how version changes are communicated to downstream packages.
Acceptance criteria
- Exported artifacts include documented version markers where the contract says they should.
- Tests cover the canonical artifact set and fail clearly on contract drift.
- Downstream adapter work can rely on the validated surface instead of internal serialization details.
Reactions are currently unavailable
Metadata
Metadata
Assignees
Labels
priority:highHigh impact or urgent release workHigh impact or urgent release workscope:adaptersAdapter integration layersAdapter integration layersscope:study-schemaStudy schema and validation contractsStudy schema and validation contractsstatus:readyReady to startReady to starttype:integrationIntegration with external repos or toolsIntegration with external repos or toolstype:testingTest coverage, fixtures, or validation workTest coverage, fixtures, or validation work