gap-analysis

Compare commit message intent against codebase state to identify functional gaps.

Updated Nov 7, 2024
One-click install
npx skills add https://github.com/patmaddox/lab --skill gap-analysis-patmaddox
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: gap-analysis
Source: https://github.com/patmaddox/lab/tree/main/.claude/skills/gap-analysis
Command: npx skills add https://github.com/patmaddox/lab --skill gap-analysis-patmaddox

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This skill resolves the ambiguity between what a developer intends to build, as described in commit messages, and the actual state of the codebase, preventing drift and ensuring implementation accuracy.

Core Features & Use Cases

  • State Comparison: Automatically compares commit message descriptions against the current working copy and codebase state.
  • Gap Identification: Generates a structured org document highlighting missing features, structural differences, and necessary assumptions.
  • Use Case: Use this when you have a series of uncommitted changes and want to verify if your current code implementation matches the architectural goals defined in your recent commit history.

Quick Start

Run the gap-analysis skill to generate a report comparing your current working directory against the latest commit history.

Frequently Asked Questions about gap-analysis

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

FAQPage Schema
How do I verify my codebase implementation matches commit message intent?

Gap analysis compares commit message descriptions against the current working copy state to identify functional gaps. It parses version control logs and file system states to produce a structured org-mode report highlighting missing features and structural differences.

What is the best way to find discrepancies between uncommitted changes and recent commit history?

Performing a gap analysis automatically compares your uncommitted changes against recent commit history. It generates a comprehensive org document that highlights missing features, structural differences, and necessary architectural assumptions to prevent codebase drift.

Does gap analysis work with Jujutsu version control tools?

Yes, gap analysis requires access to Jujutsu (jj) version control tools to perform comparative analysis. It leverages standard file system read permissions alongside jj to parse version control logs and evaluate codebase implementation states.

Can I identify missing features and structural differences in an uncommitted codebase?

Yes, gap identification evaluates the delta between commit message intent and actual implementation to find missing features. It outputs a structured org-mode report detailing structural differences and necessary assumptions required for implementation accuracy.

When do I need to run a gap analysis on my codebase?

Run gap analysis when you have a series of uncommitted changes and need to verify if your current code implementation matches the architectural goals defined in your recent commit history. This prevents ambiguity and drift between intent and actual state.