PolicyEngine / PolicyEngine/python-package-docs

Update docs away from split policyengine-us-data state H5 example

未關閉
#2 0 則留言 0 個 reaction 已指派 0 人 在 GitHub 檢視

還沒有人認領這個 Issue。

主要語言
JavaScript
星號
0
分支
0
平均合併
20 分鐘
30 天內合併 PR
1

描述

PolicyEngine/populace#237 removed release generation for one-file-per-state and one-file-per-district artifacts. The replacement path is the single certified Populace national H5 plus the standard region/scoping machinery in policyengine.py, not direct hf://policyengine/policyengine-us-data/states/... or districts/... files.

GitHub code search still finds split-H5 references in this repo:

  • src/app/page.jsx

Migration checklist:

  • Stop constructing or documenting policyengine-us-data/states/*.h5 and policyengine-us-data/districts/*.h5 dataset URIs.
  • Use the certified Populace default dataset through policyengine.py, with region filters/scoping for state and congressional-district analyses.
  • Add or update a regression test so future state/CD runs do not depend on split regional H5 files.
  • Keep historical/generated output unchanged unless it is actively used by the app or docs.

貢獻指南

開啟貢獻指南

從這裡開始

  1. 先讀完整個 Issue,再讀專案的貢獻指南。
  2. 在 Issue 下留言說明你要接手 —— 這能避免兩個人做同樣的事。
  3. Fork 儲存庫,在一個分支上完成修改。
  4. 送出 Pull Request,並在描述裡引用這個 Issue 編號。

研究方向

從 src/app/page.jsx 開始,檢查它如何建構或記錄州和國會選區的 H5 URI。閱讀 policyengine.py 中的區域/scoping 路徑,然後新增或更新涵蓋州和國會選區執行的回歸測試。當應用程式或文件中的有效參照使用經認證的全國 Populace 資料集,而不是拆分的區域 H5 檔案時,即表示完成。

由索引模型根據 Issue 內容生成。

評估

技術堆疊
javascript
領域
documentation, testing, web-dev
Issue 類型
文件
難度
3/5
預估耗時
1-2 天
活躍度
冷清
描述清晰度
基本清楚
新手友好度
67/100

把新 issue 寄到你的電子郵件信箱

精選適合新手參與的 GitHub issue 摘要。