pr-readiness-check

Scan branch diffs for missing tests, JSDoc, and guideline violations.

3.0k|1.6k|Updated Jul 18, 2018
One-click install
npx skills add https://github.com/MetaMask/metamask-mobile --skill pr-readiness-check
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: pr-readiness-check
Source: https://github.com/MetaMask/metamask-mobile/tree/main/.agents/skills/pr-readiness-check
Command: npx skills add https://github.com/MetaMask/metamask-mobile --skill pr-readiness-check

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Analyze PRs to surface readiness gaps such as missing tests, absent JSDoc, and guideline violations to improve review quality and merge readiness.

Core Features & Use Cases

  • Automated diff analysis: Scans changed files in a branch to detect missing tests and documentation.
  • Quality gate & guidelines checks: Flags potential guideline violations and documentation gaps before PR submission.
  • Use Case: When preparing to open a PR, run the check to get a report highlighting items to address for readiness.

Quick Start

Run the pr-readiness-check on the current branch to generate a readiness report for the upcoming PR.

Frequently Asked Questions about pr-readiness-check

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

FAQPage Schema
How do I check for missing tests and JSDoc before opening a pull request?

To check for missing tests and JSDoc before opening a pull request, run an automated diff analysis on your current branch to flag readiness gaps and guideline violations across changed files.

What is PR readiness analysis and how does it scan a branch diff?

PR readiness analysis scans your branch diff to identify pre-merge gaps by enforcing checks against project guidelines, flagging missing tests, and detecting absent JSDoc in changed files.

How do I automate code reviews to detect guideline violations in changed files?

Automate code reviews by running a diff analysis check on your current branch, which enforces project guidelines and surfaces documentation or testing gaps across changed files before submission.

Can I use a diff analysis check to audit my branch for absent JSDoc?

Yes, you can use a diff analysis check to audit your branch for absent JSDoc, generating a readiness report that highlights missing documentation and guideline violations prior to merging.

What are the limitations of automated PR readiness checks?

Automated PR readiness checks require access to the diff output and are limited to flagging missing tests, absent JSDoc, and guideline violations, meaning they cannot evaluate complex architectural logic.

Does PR readiness checking work for pre-merge quality gates?

Yes, PR readiness checking works for pre-merge quality gates by scanning the current branch diff to surface missing tests and documentation issues, ensuring code meets typical testing standards before review.