bug-receipt

Generates structured bug closeout receipts with verified, partial, or blocked status after diagnosis and repair.

38.5k|4.9k|Updated Jun 11, 2025
One-click install
npx skills add https://github.com/github/awesome-copilot --skill bug-receipt
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: bug-receipt
Source: https://github.com/github/awesome-copilot/tree/main/skills/bug-receipt
Command: npx skills add https://github.com/github/awesome-copilot --skill bug-receipt

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes scripts (resource) and references (resource) and assets (resource) components.

What problem does it solve?

Bug fixes often close without clear evidence of what was broken, what changed, or whether the fix was actually proven. This Skill enforces a disciplined closeout process that produces a standardized BUG RECEIPT documenting the problem, root cause, change, and proof for every defect or incident.

Core Features & Use Cases

  • Mandatory Receipt Output: Returns a fixed-format BUG RECEIPT with VERIFIED, PARTIAL, or BLOCKED status, ensuring no closeout skips the evidence trail.
  • Evidence Discipline: Separates observed facts from hypotheses, requires decisive proof per surface (UI, API, persistence, concurrency), and caps unproven results at PARTIAL or BLOCKED.
  • Machine-Readable Artifacts: Generates JSON receipts from a template and validates them against a schema using the bundled Node.js validator script.
  • Use Case: After fixing a failing checkout discount calculation, produce a VERIFIED receipt showing the failing test baseline, the root cause in the pricing module, the applied change, and the passing verification checks.

Quick Start

Ask the agent to close out the bug you just fixed and produce a bug receipt with verified status and proof of the fix.

Frequently Asked Questions about bug-receipt

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

FAQPage Schema
How do I document a bug fix with proof of verification?

Use the bug receipt format, which records the problem, failing baseline, root cause, responsible change, and verification checks in a fixed structure. The closeout is assigned VERIFIED, PARTIAL, or BLOCKED status based on whether every required proof layer passed.

What is the difference between VERIFIED, PARTIAL, and BLOCKED bug status?

VERIFIED requires an observed baseline, concrete root cause, a responsible change, and all checks passing with no gaps. PARTIAL means useful evidence exists but a proof layer is missing, and BLOCKED means an external condition prevents reproduction, repair, or proof.

How do I validate a bug receipt JSON file?

Run node scripts/validate-receipt.mjs <receipt.json> from the skill directory to check the receipt against the contract. You can also pipe JSON via stdin with the --json flag for machine-readable validation output.

What proof is required to verify a UI or API bug fix?

UI fixes require real interaction plus console and network observation, while API fixes require the request, response, and responsible service behavior. Persistence claims need a write/read round trip through the real owner path.

When should a bug closeout be marked PARTIAL instead of VERIFIED?

Mark PARTIAL when a required proof layer is missing or inconclusive, such as an unreproduced failure or an unrun regression check. The receipt must name the single minimal experiment or evidence package that would close the gap.