Repository navigation
Yearly Data Updates
Some rule values change on a fixed calendar. This page explains the two yearly refreshes, how to do them, and what the app does when data gets old. It is for maintainers and contributors who update reference data.
The process is defined in docs/STATE_ADAPTERS.md
("Reference-data refresh"). The values come from
scripts/seed-fpl-data.ts.
The values in the repository today are illustrative 2024 and FY2024 figures, pending expert review. Do not copy them anywhere as real limits.
| When | What changes | Source | Files |
|---|---|---|---|
| January | Federal poverty guidelines (FPL), for the contiguous states, Alaska, and Hawaii | HHS poverty guidelines | data/federal/poverty-guidelines.*.json |
| October | SNAP maximum allotments, standard deductions, shelter cap, and other federal SNAP values (new federal fiscal year) | USDA FNS | data/federal/snap.json |
State adapters can also change at any time. Those follow Add or change a rule.
-
Read the new official figures. HHS publishes the poverty guidelines each January; USDA FNS publishes SNAP cost-of-living adjustments for the fiscal year that starts in October.
-
Open an issue and note the source links and publication dates. Changing reference values needs maintainer approval.
-
Update the constants in
scripts/seed-fpl-data.ts:- January:
fplTables,FPL_YEAR,FPL_EFFECTIVE, andFPL_REFRESH(the date the data should next be refreshed). - October: the
snapobject, including itseffectiveDateandexpectedRefreshDate.
- January:
-
Regenerate the files:
npm run seed:fpl
-
Check the generated files with
git diffbefore going further. Make sure every field that was indata/federal/snap.jsonis still there. (The seed script does not writeabawdMinAge,abawdMaxAge, orelderlyAge, and the validator requires them. Keep them in the file.) -
Update the sources in
data/federal/sources.json: thesourceName,url,publishedDate, andnotefor each refreshed value. The seed script does not touch this file. -
Check
dataVersion. TodaydataVersionis the FPLyear, so changingFPL_YEARin January changes it. An October SNAP-only update does not change it; say so in your pull request so a maintainer can decide how to label the data. -
Run the checks:
npm run validate:adapters npm run test:fixtures npm run verify
Some benefit-amount test cases will change with new SNAP values. Do not just copy the new numbers into
expectedBenefits: check them against the official tables, explain each change, and get a maintainer to agree. -
Ask for re-verification. Experts need to review the new values. Record the review in
docs/SME_SIGNOFF.md. Adapters staydraftuntil a human expert signs off. -
Add a
Dataentry toCHANGELOG.mdunder## [Unreleased], and open the pull request. A release that only changes reference data bumps the patch version (Making a release).
The engine adds the reason DATA_MAY_BE_OUT_OF_DATE to the top of every result when any of these
is true on the screening date:
- the FPL table's
expectedRefreshDatehas passed; - the SNAP data's
expectedRefreshDatehas passed; - the state adapter's
lastVerifieddate is more than 365 days old.
People see: "These figures may be out of date. Please double-check with the agency." Because the repository's data is from 2024, this notice shows on screenings today.
When someone opens a saved screening at /resume and the save file's dataVersion is different
from the app's, the app warns: "The rules changed since you saved. Please re-check your results."
OpenBridge is a prototype. Its rules are drafts that experts have not verified yet, and results are
estimates, not decisions. It is not legal advice. Need help applying for benefits? Call 211 or visit
211.org. This wiki is edited in the wiki/ folder of the repository.
Questions: openbridge@starlingtek.com.
Start here
Use OpenBridge
- Using OpenBridge
- Understanding your results
- Guide for navigators
- Privacy and your data
- Run it on your computer
- Host it for others
- Use it with an AI assistant
Help without code
- Ways to help
- Review rules as an expert
- Record a test case
- Report a rule problem
- Translate OpenBridge
- Test accessibility
- Community rule toolkit
Rules and policy (with code)
- How the rules engine works
- State adapters
- Add or change a rule
- Add a new state
- Golden test cases
- Yearly data updates
Developers