Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Agent Instructions

Read and follow [agent-instructions.md](agent-instructions.md) before changing this repository.
Read and follow [agent-instructions.md](agent-instructions.md) before changing this repository. It is the vendor-neutral source of truth for all agents.
2 changes: 1 addition & 1 deletion CLAUDE.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,3 @@
# Agent Instructions

Read and follow [agent-instructions.md](agent-instructions.md) before changing this repository.
Read and follow [agent-instructions.md](agent-instructions.md) before changing this repository. It is the vendor-neutral source of truth for all agents.
11 changes: 11 additions & 0 deletions agent-instructions.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,17 @@ Read this file before changing anything.
- An API response change must pass `s/compatibility-test` against every supported immutable Chart Component profile. If the committed component fixtures are affected, run the sibling repository's `s/generate-fixtures` against the updated local server, review and commit the generated fixture changes there, and validate its tests and Storybook build.
- Preserve calculation provenance from `rcpchgrowth` unchanged and keep the API server provenance fields accurate.

## Cross-Repository Impact

This API is the second layer in the product chain: `rcpchgrowth-python` (calculations) → this API (HTTP contract and provenance) → `digital-growth-charts-react-component-library` (plotting) → `digital-growth-charts-react-client` (demo and E2E) → `digital-growth-charts-documentation` (integration, safety and release guidance). Use the [Five-Repository Upgrade Runbook](https://growth.rcpch.ac.uk/developer/five-repository-upgrade-runbook/) whenever a change crosses a repository boundary or affects a public contract.

- If the Python engine changes values, supported ages, boundaries, errors, provenance or exported behavior, test the exact candidate wheel/commit through this server's regression suite and `s/compatibility-test`. Do not update response goldens until the numerical difference is understood and approved.
- If an API response changes, review normalized OpenAPI and real success/error responses. Run compatibility against all supported component profiles; if component fixtures need updating, generate them in the component repository against this server candidate and review its test and Storybook results.
- If the component, demo or published integration guidance changes as a consequence, coordinate the corresponding repository and test the combined versions. Document which repositories are affected and which are not in the upgrade record or PR.
- Test pinned candidate revisions or artifacts, not an assumed local sibling checkout. Confirm what the harness selected and record version/commit identities.

Not every API change needs all five repositories. Record affected and unaffected layers with reasons; a green server-only suite does not establish downstream compatibility.

## Workflow

- `s/up` - build and run the API locally.
Expand Down
Loading