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 摘要。