PolicyEngine / PolicyEngine/policyengine-app-v2

Standardize local-storage association key names

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

Nobody has claimed this yet.

Dominant language
HTML
Stars
1
Forks
3
Avg merge
1d 50m
Merged PRs (30d)
39

Description

TanStack Query keys are now centralized in app/src/libs/queryKeys.ts. The remaining inconsistency is in local-storage keys used for user ingredient associations.

For example, household associations use user-population-households, while geographic associations use user-geographic-associations; related records use names such as user-policy-associations, user-report-associations, and user-simulation-associations.

Choose one naming convention, update the stores consistently, and include a migration or compatibility read so existing locally stored records are not lost.

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 app/src/libs/queryKeys.ts, then search the stores for the local-storage keys listed in the issue. Choose one convention and apply it consistently across the association stores, while verifying that records written with the previous names remain readable through the required migration or compatibility path.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
frontend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.