pr-review

Automate code review with ReadLints lint/type checks and shell-based validation.

341|48|Updated Apr 4, 2025
One-click install
npx skills add https://github.com/WellApp-ai/Well --skill pr-review-wellapp-ai
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-review
Source: https://github.com/WellApp-ai/Well/tree/main/cursor-rules/skills/pr-review
Command: npx skills add https://github.com/WellApp-ai/Well --skill pr-review-wellapp-ai

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill automates rigorous code validation before commits by orchestrating ReadLints for lint/type checks and Shell-driven validation steps, reducing human review effort and preventing bad code from entering your codebase.

Core Features & Use Cases

  • Automated pre-commit validation: Run lint and syntax checks before commits or PRs to catch issues early.
  • Deterministic phase-based checks: Phase 0 auto-resolves environment readiness; Phase 1 validates TypeCheck, Lint, and ReadLints results.
  • CI/CD integration: Works with existing pipelines to ensure consistent validation across pushes and merges.
  • Use Case: Before pushing a PR, invoke the pr-review skill to ensure all lint/type checks pass and shell-based validations succeed.

Quick Start

Use the pr-review skill to perform runtime and technical validation before committing by following the Phase 0-2 instructions to ensure the local environment is ready and code passes checks.

Frequently Asked Questions about pr-review

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

FAQPage Schema
How do I automate code review for pre-commit hooks and pull requests?

Automated code review uses ReadLints and Shell execution to validate lint and type checks before commits or pull requests. Phase 0 resolves local environment readiness, while Phase 1 validates TypeCheck and Lint results to catch issues before integration.

What is the best way to run lint and type checks before pushing a PR?

Running lint and type checks before a PR requires deterministic phase-based validation using ReadLints. The system auto-resolves environment readiness in Phase 0, then validates TypeCheck, Lint, and ReadLints results in Phase 1 to prevent bad code from entering your codebase.

Can I integrate shell-based validation into my existing CI/CD pipeline?

Shell-based validation integrates with existing CI/CD pipelines to ensure consistent validation across pushes and merges. It leverages Docker services and required tooling during runtime to execute validation commands automatically.

Does this automated code review work with Docker services for environment readiness?

Automated code review works with Docker services by auto-resolving environment readiness during Phase 0. The runtime leverages these services alongside required tooling to ensure the local environment is ready before executing shell-based validation.

Why do I need deterministic phase-based checks for local development?

Deterministic phase-based checks are needed to reduce human review effort and prevent integration failures. Phase 0 auto-resolves environment readiness, and Phase 1 validates lint and type results, ensuring rigorous code validation before commits.

What are the limitations of using ReadLints for pull request validation?

ReadLints for pull request validation is limited to enforcing lint, type checks, and shell-based validation. It relies on the runtime successfully auto-resolving environment readiness and required tooling, meaning unresolved local dependencies will halt validation.