What problem does it solve?
This Skill prevents failed commits and PRs by running the same style, header, annotation, export, and docstring checks that the CI pipeline enforces.
Core Features & Use Cases
- Enforces code style with a Black formatting gate that mirrors CI behavior.
- Validates licensing and module hygiene by checking the required Apache 2.0 header, presence of
from __future__ import annotations, and correctness of __all__ exports in public modules.
- Improves API quality and maintainability by requiring Google-style docstrings, type annotations, and correct
@configclass usage for configuration classes.
- Supports reliability by verifying that new public modules/functions include corresponding tests with the same header requirements.
Quick Start
Run the pre-commit-check skill before committing or creating a PR, especially after you change any .py files, to produce a local pass/fail summary aligned with CI.