pr-ready-check

Run pull request readiness checks with ruff, pytest, and coverage validation.

7|4|Updated Feb 12, 2024

Search Tags:#code quality #automation #testing #linting #ci #pr check

Ready to run

npx skills add https://github.com/ll7/robot_sf_ll7 --skill pr-ready-check

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: pr-ready-check
Source: https://github.com/ll7/robot_sf_ll7/tree/main/.codex/skills/pr-ready-check
Command: npx skills add https://github.com/ll7/robot_sf_ll7 --skill pr-ready-check

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) components.

What problem does it solve?

This Skill automates the crucial pre-submission checks for your pull requests, ensuring code quality, test coverage, and documentation standards are met before merging.

Core Features & Use Cases

Automated Pipeline Execution: Runs the same checks used in local VS Code tasks via stable scripts/dev entry points.
Comprehensive Validation: Includes linting, formatting, parallel testing, changed-files coverage, and docstring TODO checks.
Use Case: Before submitting a feature branch for review, run this Skill to catch any linting errors, ensure tests pass, and verify that documentation is up-to-date, preventing common merge conflicts and review delays.

Quick Start

Run the pr-ready-check skill with the default base reference of origin/main.

Frequently Asked Questions about pr-ready-check

High-intent search queries and answers about installing and using this skill.

FAQPage Schema

How do I automate pull request readiness checks for linting and test coverage?▼

Automate pull request readiness checks by running a pipeline that validates code quality with ruff fix/format, executes parallel pytest runs, verifies changed-files coverage, and checks docstring TODOs.

What is included in a pre-submission PR validation pipeline?▼

A pre-submission PR validation pipeline includes linting and formatting via ruff, parallel test suite execution with pytest, changed-files coverage verification, and docstring TODO checks.

How do I run parallel pytest executions to verify test suite integrity before merging?▼

Run parallel pytest executions to verify test suite integrity by triggering an automated PR readiness pipeline that leverages shared development scripts to test against a defined base reference.

Can I use this automated PR check without setting up a specific local environment?▼

No, the automated PR check operates within a specific repository context and leverages local environment setup alongside stable shared development scripts to execute its comprehensive validation pipeline.

What's the best way to catch linting errors and formatting issues before submitting a feature branch?▼

Catch linting errors and formatting issues before submitting a feature branch by executing an automated readiness pipeline that applies ruff fix and format checks against the origin/main base reference.

Why does my PR check fail when there are unresolved TODOs in my docstrings?▼

Your PR check fails on unresolved TODOs because the automated validation pipeline includes a specific docstring TODO check to ensure documentation standards are met prior to merging.