Skip to content

Commit d22d267

Browse files
MaxGhenisclaude
andauthored
Replace modelled_policies.yaml with structured programs.yaml (#1516)
* Replace modelled_policies.yaml with structured programs.yaml Replaces plain string lists with structured program objects containing id, name, category, agency, status, variable, parameter_prefix, verified_years, and notes. Covers 37 UK programs across HMRC, DWP, DfE, DCMS, Treasury, Ofgem, Revenue Scotland, and Social Security Scotland. Renames from modelled_policies.yaml to programs.yaml. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add programs.yaml guidance to CLAUDE.md Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> * Add changelog fragment for programs.yaml migration Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> --------- Co-authored-by: Claude Opus 4.6 <noreply@anthropic.com>
1 parent f863d05 commit d22d267

5 files changed

Lines changed: 427 additions & 26 deletions

File tree

CLAUDE.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,14 @@
2323
- **Versioning**: Follow SemVer (increment patch for fixes, minor for features, major for breaking changes)
2424
- **Pull Requests**: Must include a changelog.d/ file describing the changes (GitHub Actions will automatically run `make changelog` to update the changelog)
2525

26+
## Program registry (programs.yaml)
27+
- `policyengine_uk/programs.yaml` is the single source of truth for program coverage metadata
28+
- Served via the `/uk/metadata` API and consumed by the model coverage page
29+
- **When adding a new program**: add an entry with `id`, `name`, `full_name`, `category`, `agency`, `status`, `coverage`, `variable`, `parameter_prefix`
30+
- **When extending year coverage**: update `verified_years` after verifying parameters and tests cover the new year
31+
- **When adding devolved programs**: use the appropriate agency (e.g., `Revenue Scotland`, `Social Security Scotland`)
32+
- **Status values**: `complete`, `partial`, `in_progress`
33+
2634
## Repository Structure
2735
- **parameters/**: YAML files that define tax rates, thresholds, and other policy parameters
2836
- Organized by government department (e.g., gov/hmrc/, gov/dwp/, gov/dfe/)
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Replace modelled_policies.yaml with structured programs.yaml containing rich metadata for all 37 modelled programs.

policyengine_uk/modelled_policies.yaml

Lines changed: 0 additions & 25 deletions
This file was deleted.

0 commit comments

Comments
 (0)