PolicyEngine / PolicyEngine/microcosm

Rename the ledger vocabulary to chronicle across the repo

Open
#737 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
4
Avg merge
1d 3h
Merged PRs (30d)
94

Description

The upstream repo was renamed ledger → chronicle; microcosm's vocabulary should follow. One dedicated mechanical PR, landing right after #735 merges (adjudicated 2026-08-21: kept out of #735 so its semantic diff stays reviewable).

Blast radius (measured on the #735 branch): 142 files, ~4,960 case-insensitive occurrences. Scope:

  • Modules: ledger_targets.pychronicle_targets.py, ledger_artifact.pychronicle_artifact.py (and uk_runtime/ledger_targets.py).
  • Classes/functions: LedgerTargetReference, compile_ledger_target_references, load_ledger_consumer_artifact, ledger_target_registry_parity_report, … → chronicle spellings.
  • CLI flags: --ledger-facts / --ledger-facts-sha256 / --ledger-manifest-sha256--chronicle-* (keep the old flags as hidden aliases for one release).
  • Gate ids: ledger_compile_parity_*; resource filenames: uk/ledger_compile_parity_*_signed_differences.json; JSON keys inside committed resources (ledger_selector, ledger_* metadata stamps).
  • Docs, comments, test names.

Compatibility constraints:

  • The consumer-artifact schema string policyengine_ledger.consumer_artifact.v1 is emitted by chronicle's exporter — accept BOTH strings until a coordinated chronicle-side successor lands (file the chronicle issue alongside this one).
  • Renaming JSON keys/gate ids/filenames moves content-addressed pins: re-pin the spec bundle SHA, CountrySpec fingerprints, and the _UK_GATE_BATTERY_* digests by recomputation.
  • Follow the repo-rename checklist in the standards doc.

Acceptance: grep-zero for the old term outside compatibility shims and historical records; full suite green; all pins recomputed.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the repo-rename checklist in the standards document and inspect the #735 branch, especially ledger_targets.py, ledger_artifact.py, and uk_runtime/ledger_targets.py. Track the compatibility shims and recompute the named pins after renaming keys, gate ids, and filenames. Done means grep-zero outside shims and historical records, the full suite is green, and all pins are recomputed.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
cli, testing, tooling
Issue type
Refactor
Difficulty
5/5
Estimated time
Over a week
Activity status
Active
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.