What problem does it solves?
Maintaining high code quality, ensuring consistent development practices, and passing continuous integration (CI) checks across a multi-repository ecosystem can be challenging. This Skill provides a comprehensive guide to PolicyEngine's development standards, streamlining your workflow and preventing common errors.
Core Features & Use Cases
- Coding Standards: Guidelines for Python 3.13,
uv run for commands, and Jupyter Book 2.0 for documentation.
- Test-Driven Development (TDD): Promotes writing tests first to ensure accuracy, prevent regressions, and build confidence in refactoring.
- Automated PR Workflow: Introduces the
/create-pr command that automatically waits for CI to pass before marking a pull request as ready.
- Common AI Pitfalls: Highlights frequent mistakes made by AI-generated code, such as file versioning and unformatted commits, to help you avoid them.
- Use Case: Before submitting a pull request, use this skill to verify that your Python code is formatted with Black, all tests pass, and the PR description follows the standard, including referencing an issue.
Quick Start
Use the policyengine-standards skill to format all Python files in your current directory using Black.