PolicyEngine / PolicyEngine/python-package-docs

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

Đang mở
#2 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Chưa có ai nhận issue này.

Ngôn ngữ chính
JavaScript
Star
0
Fork
0
Merge trung bình
20 phút
Pull request đã merge (30 ngày)
1

Mô tả

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.

Hướng dẫn đóng góp

Mở hướng dẫn đóng góp

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Hướng nghiên cứu

Bắt đầu trong src/app/page.jsx và kiểm tra cách nó xây dựng hoặc ghi chép các URI H5 cấp bang và khu vực bầu cử quốc hội. Đọc đường dẫn region/scoping trong policyengine.py, sau đó thêm hoặc cập nhật một kiểm thử hồi quy bao quát các lần chạy cấp bang và khu vực bầu cử quốc hội. Hoàn tất khi các tham chiếu đang hoạt động trong ứng dụng hoặc tài liệu sử dụng dataset Populace quốc gia đã được chứng nhận thay vì các tệp H5 khu vực bị tách riêng.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Đánh giá

Công nghệ
javascript
Lĩnh vực
documentation, testing, web-dev
Loại issue
Tài liệu
Độ khó
3/5
Thời gian dự kiến
1-2 ngày
Mức độ hoạt động
Ít trao đổi
Độ rõ ràng
Khá rõ ràng
Mức phù hợp với người mới
67/100

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.