工程开发
policyengine-review-patterns
PolicyEngine 代码库的标准审查模式、验证清单与质量基准。
简介
policyengine-review-patterns 技能提供了一套完整的框架,用于在 PolicyEngine 生态系统中进行严格的代码审查。该工具专为工程师和政策建模人员设计,确保税收与福利计划的实施精确、高效且易于维护。此技能强调代码变更背后的逻辑,要求审查人员区分必要的特定州别逻辑与不必要的封装变量,后者往往会增加代码库的负担却无实质效益。通过强制执行一致的标准,此技能有助于防止常见错误,例如向量化违规、硬编码数值以及法规来源文件不足等问题。
-
针对向量化错误与无效参数来源等关键失败点提供自动化与手动验证清单。
-
用于检测不必要的封装变量之模式,避免在未进行转换的情况下复制联邦变量。
-
标准化的反馈模板,以优化审查人员与贡献者之间的沟通流程。
-
严格的文档要求,包括验证美国法典 (USC)、联邦法规 (CFR) 及各州特定的一手资料来源。
-
测试结构的最佳实践,确保测试案例使用正确的命名规范、有效的周期与详细的计算逻辑标注。
-
针对识别降低模型弹性与可扩展性的硬编码数值提供指导。
-
确保所有涉及家庭或个人的逻辑均已完全向量化,以支持微观模拟的性能需求。
-
验证外部链接是否指向行政法规或法令等权威来源,而非一般的政府网站。
-
在审查各州特定实施项目时,确认是否确实利用了各州参数,且公式执行了有意义的数据转换。
-
使用提供的审查反馈模板,确保向 PR 作者提供建设性且可操作的建议。
-
密切注意单元测试,确保测试内容包含正确的数字分隔符与准确的计算说明。
-
请记住 PolicyEngine 依赖于声明式结构;避免在数据驱动计算中使用 if-elif-else 等手动控制流程,应优先使用 where 与 select 方法。
仓库统计
- Star 数
- 28
- Fork 数
- 5
- Open Issue 数
- 7
- 主要语言
- Python
- 默认分支
- main
- 同步状态
- 空闲
- 最近同步时间
- 2026年5月3日 17:07