PolicyEngine / PolicyEngine/python-package-docs

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

Aberta
#2 0 comentários 0 reações 0 responsáveis Ver no GitHub

Ninguém assumiu esta issue ainda.

Linguagem predominante
JavaScript
Estrelas
0
Forks
0
Merge médio
20min
PRs com merge (30d)
1

Descrição

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.

Guia de contribuição

Abrir o guia de contribuição

Primeiros passos

  1. Leia a issue inteira e depois o guia de contribuição do projeto.
  2. Comente na issue dizendo que vai assumir — evita que duas pessoas façam o mesmo trabalho.
  3. Faça um fork do repositório e trabalhe em uma branch.
  4. Abra um pull request que referencie o número da issue.

Direção de pesquisa

Comece em src/app/page.jsx e inspecione como ele constrói ou documenta URIs H5 de estados e distritos congressionais. Leia o caminho de região/scoping de policyengine.py e, em seguida, adicione ou atualize um teste de regressão que cubra execuções de estados e distritos congressionais. O trabalho estará concluído quando as referências ativas no aplicativo ou na documentação usarem o dataset nacional certificado da Populace em vez de arquivos H5 regionais divididos.

Escrita pelo modelo de indexação a partir do texto da issue.

Avaliação

Stack de tecnologia
javascript
Domínio
documentation, testing, web-dev
Tipo de issue
Documentação
Dificuldade
3/5
Tempo estimado
1-2 dias
Status de atividade
Pouca atividade
Clareza
Razoavelmente clara
Facilidade para iniciantes
67/100

Receba novas issues na sua caixa de entrada

Um resumo curto de issues do GitHub para quem está começando.