工程開發
policyengine-review-patterns avatar

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日 下午05:07
在 GitHub 查看