github-publish-review-gate

Validate GitHub repository README and docs for product scope and runtime.

Updated Mar 16, 2026

Search Tags:#documentation #github #readme #release #handoff #licensing #quality-assurance

Ready to run

npx skills add https://github.com/BSchafer01/PanelNester --skill github-publish-review-gate

💬 Prompt for ChatGPT / Claude Chat▼

Please help me install this Agent Skill.
Skill: github-publish-review-gate
Source: https://github.com/BSchafer01/PanelNester/tree/main/.squad/skills/github-publish-review-gate
Command: npx skills add https://github.com/BSchafer01/PanelNester --skill github-publish-review-gate

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

Gate a public GitHub repository handoff by validating that the root README and accompanying docs accurately reflect product scope and required runtime.

Core Features & Use Cases

Evaluate a repository's public documentation to ensure it describes the product shape, supported platforms, and core workflows implemented.
Split contributor prerequisites from runtime prerequisites and confirm explicit license posture and release guidance.
Make the handoff discoverable by requiring build/test instructions and a public destination or release path, and enforce blockers for missing licensing or release information.

Quick Start

Ensure the repository has a root README, clearly distinguish contributor prerequisites from runtime requirements, and provide a publish-ready license and release destination.

Frequently Asked Questions about github-publish-review-gate

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

FAQPage Schema

How do I validate my GitHub README before making a repository public?▼

A public GitHub handoff requires a root README that accurately describes product scope and runtime requirements. It must clearly separate contributor prerequisites from runtime requirements and include explicit licensing posture, a release destination, and a blockers list to prevent misrepresentation.

What documentation is required for a public GitHub repository handoff?▼

How do I separate contributor setup from runtime requirements in my README?▼

Separate contributor setup from runtime requirements by explicitly splitting the documentation sections in your README. The handoff gate validates that contributor prerequisites for building and testing are distinctly categorized from the environment needed to run the published product.

Does my repository need a license and release notes before publishing to GitHub?▼

Yes, a public GitHub handoff requires an explicit license posture and a published destination or release story. The gate enforces blockers for missing licensing or release information to ensure the handoff is discoverable and prevents product misrepresentation.

What is the best way to ensure my GitHub release notes match the actual product scope?▼

The best way to ensure release notes match product scope is to gate the handoff by evaluating the repository's public documentation. This validates that the README and accompanying docs accurately describe the product shape, supported platforms, and core workflows implemented.

When should I use a documentation review gate for a GitHub repository push?▼

Use a documentation review gate for new public GitHub pushes where a README, packaging guidance, or release notes are added. It prevents misrepresentation by enforcing that build and test instructions, licensing, and a public release path are discoverable.