A lightweight framework for defining and validating supplier integration contracts for HomeTest-style integrations. The repo is structured to make it easy to version, review, and automate checks against schemas and contractual changes over time.
schemas/— Version-controlled schema definitions that describe the integration contract(s).schemas/CHANGELOG.md— Human-readable record of notable changes between releases.
- Contract-first integrations: agree a stable interface with suppliers using schemas as the source of truth.
- Validation in CI/CD: automatically validate payloads/artifacts against the schemas.
- Change control & governance: track breaking vs non-breaking changes via PR review + changelog + versioning.
git clone <REPO_URL>
cd hometest-supplier-integration-framework
- Add or update schema files under
schemas/. - Keep schema changes small and reviewable—prefer incremental PRs to large rewrites.
- Create a branch describing the change.
- Update schemas in
schemas/. - Update
CHANGELOG.mdwith:- what changed,
- why it changed,
- impact (breaking/non-breaking),
- any migration notes.
- Open a PR and use the PR template to capture:
- test evidence,
- rollout/migration plan,
- stakeholder sign-off if required.
Contributions are welcome via pull requests. See CONTRIBUTING.md for full details, including how to fork the repository and set up GPG commit signing.
- Use the existing issue templates for bug reports/requests.
- Follow the PR template to ensure changes are auditable and easy to review.
- Keep changes focused: one contract change per PR where practical.
- Ensure documentation (especially
schemas/CHANGELOG.md) is updated alongside schema changes.
See LICENCE.md for licensing details.
Any HTML or Markdown documentation is © Crown Copyright and available under the terms of the Open Government Licence v3.0.