review-pr

Automates GitHub pull request reviews for correctness, security, and quality issues.

219|41|Updated Feb 21, 2024
One-click install
npx skills add https://github.com/proto-at-block/bitkey --skill review-pr-proto-at-block
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: review-pr
Source: https://github.com/proto-at-block/bitkey/tree/main/app/ai-rules/skills/review-pr
Command: npx skills add https://github.com/proto-at-block/bitkey --skill review-pr-proto-at-block

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Automates thorough pull request reviews to identify correctness, security, and quality issues.

Core Features & Use Cases

  • Checklist-driven review: Applies a predefined checklist from references/checklist.md to ensure consistency.
  • Diff and risk analysis: Evaluates changed code, potential side effects, and security implications.
  • Documentation and tests alignment: Flags gaps between changes and tests/docs to improve coverage.

Quick Start

Review the specified PR and generate a structured assessment focusing on correctness, security, and quality.

Frequently Asked Questions about review-pr

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

FAQPage Schema
How do I automate a pull request review for correctness and security?

To automate a pull request review, this Skill analyzes GitHub PR diffs, checks, tests, and documentation to flag correctness issues, security risks, and quality gaps. It applies a predefined checklist to ensure consistent, structured assessments across different programming languages.

What is the best way to ensure my code changes align with existing tests and documentation?

To ensure code changes align with tests and documentation, this PR review process evaluates the diffs and flags gaps between the modified code and existing test or doc coverage. This helps improve overall alignment and prevents unintended side effects before merging.

Can I use a custom checklist to review GitHub PRs for quality issues?

Yes, you can use a custom checklist to review GitHub PRs. This Skill loads its review criteria from a references/checklist.md file, allowing you to apply a predefined, structured checklist to evaluate security risks and quality gaps consistently across languages.

How does checklist-driven code review work for identifying security risks?

Checklist-driven code review works by applying a predefined set of criteria from a markdown file to analyze code diffs. It systematically evaluates changed code and potential side effects to identify security implications, correctness flaws, and quality gaps.

Does automated PR review work across different programming languages?

Yes, automated PR review works across different programming languages. This Skill applies to GitHub PRs universally, analyzing diffs, checks, and tests regardless of the language to flag unintended changes and security risks consistently.

What is included in a structured pull request assessment output?

A structured pull request assessment output includes findings on correctness, security, and quality. The Skill generates this review by following an output format defined in its references, ensuring the final assessment is organized and consistent.