القائمة
Ensures all quality checks pass locally before committing changes. Use this skill to validate code quality, tests, and type checking before creating commits to catch issues early and avoid CI failures.
التثبيت باستخدام Codex أو Claude انسخ هذا Prompt والصقه في Codex أو Claude أو مساعد آخر ليراجع صفحة Skill ويثبّتها لك.
استنادا إلى تصنيف SOC المهني
Defines patterns for implementing FastAPI REST endpoints, including route definition, request/response models, error handling, and integration tests. Use when implementing any API endpoint to ensure consistency and best practices across endpoints.
Ensures all git commits follow the Conventional Commits specification with consistent types and scopes. Use this skill when making any commit to maintain consistent commit message format, improve git history readability, and enable automatic changelog generation.
Defines error handling patterns using custom error codes, result wrappers, and HTTP status code mapping. Use when implementing error handling in services, business logic, or API endpoints to ensure consistent error responses.
Enforce feature work on a dedicated git branch and submission via pull request. Use when implementing any feature, fix, or refactor so work is isolated, reviewed, and merged via PR.
Defines the pattern for updating project documentation when completing features. Use when marking features as complete to ensure consistent documentation of implementation status, test coverage, and deliverables.
Guides implementation of features following an established workflow pattern. Use when implementing any feature to ensure consistent process: read requirements, create todos, implement code, write tests, update documentation, commit and push.
| name | pre-commit-validation |
| description | Ensures all quality checks pass locally before committing changes. Use this skill to validate code quality, tests, and type checking before creating commits to catch issues early and avoid CI failures. |
| license | MIT |
| metadata | {"version":"1.0.0","workflow":"code changes -> run validation -> commit"} |
This skill ensures code quality and test coverage before committing changes to the repository.
Run comprehensive validation locally before committing to:
Before creating any commit, ensure ALL of the following pass:
# Run all tests
pytest tests/
# Or with coverage (recommended)
pytest tests/ --cov=src --cov-report=term
Requirements:
# Check formatting
black --check src/ tests/
# Check linting
ruff check src/ tests/
# Check types
mypy src/ --strict --explicit-package-bases
Requirements:
# Run all pre-commit hooks manually
pre-commit run --all-files
Note: Pre-commit hooks run automatically on git commit, but running them manually gives faster feedback.
Use this skill in the following scenarios:
git commit --no-verify, run validation manuallyWhen implementing features following the phase-implementation skill:
For convenience, you can run all checks in sequence:
# Run all validation checks
pytest tests/ --cov=src --cov-report=term && \
black --check src/ tests/ && \
ruff check src/ tests/ && \
mypy src/ --strict --explicit-package-bases
If all commands succeed (exit code 0), you're ready to commit.
Many issues can be auto-fixed:
# Auto-fix formatting
black src/ tests/
# Auto-fix linting issues (many can be fixed automatically)
ruff check --fix src/ tests/
After auto-fixing, re-run validation to ensure everything passes.
black src/ tests/ to auto-fixruff check --fix src/ tests/ to auto-fix many issuesImportant: Local validation does NOT replace CI/CD checks.
Even if local validation passes, CI may still catch:
However, running validation locally:
Validation should only be skipped in exceptional circumstances:
[WIP] prefix (but still validate before final commit)Note: Even in exceptions, consider running at least formatting checks to maintain code quality.