PolicyEngine / PolicyEngine/policyengine-api

Year should be hardcoded into household data objects

Open
#1,112 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
18
Forks
33
Avg merge
23h 40m
Merged PRs (30d)
22

Description

At present, we determine a calculated year through inference, which at times fails, because adding a household's year as a separate property risks harming backward compatibility. Even so, the data structure currently does not properly represent the data itself due to this inference, and hard-coding the year over which a household is to be calculated would help ensure greater app stability.

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

No files or tests are named. Start by tracing household data objects and the calculated-year inference, then inspect how adding an explicit year could affect backward compatibility. Done means household objects represent their calculation year explicitly and existing API consumers continue to work.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Needs clarification
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.