skills.rest
cacack
cacackCOMMUNITY
Explore all skills by this author →
GitHub

check-debt

Scan Go repositories for TODO comments, long functions, and test coverage gaps.

4|1|Updated Dec 7, 2025
Search Tags:#go#static-analysis#test-coverage#code-audit#technical-debt#repo-inspection#todo-comments
One-click install
npx skills add https://github.com/cacack/my-family --skill check-debt
Or copy as Structured Prompt for Agent▼
Please help me install this Agent Skill.
Skill: check-debt
Source: https://github.com/cacack/my-family/tree/main/.claude/skills/check-debt
Command: npx skills add https://github.com/cacack/my-family --skill check-debt

SYSTEM DOCUMENTATION & REQUIREMENTS

What problem does it solve?

This Skill helps engineering teams quickly discover and quantify technical debt and known gaps so they can prioritize refactors and testing efforts without manually scanning the repository.

Core Features & Use Cases

  • TODO and Comment Discovery: Finds and counts // TODO: comments and other tags (HACK, FIXME, XXX, WORKAROUND) and groups them by package.
  • Integration Matrix Validation: Parses INTEGRATION-MATRIX.md to list entities with partial (warning) status and identifies which layers are incomplete.
  • Refactor Candidates and Coverage: Detects Go functions longer than 100 lines as refactor candidates and highlights packages with low or missing test coverage.
  • Use Case: Run before planning a cleanup sprint to produce an actionable debt summary with package-level counts, file locations, and prioritized issues.

Quick Start

Run the check-debt skill to produce a summarized inventory of TODOs, hack comments, long functions, and test coverage gaps across the repository.

Frequently Asked Questions about check-debt

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

FAQPage Schema
How do I inventory technical debt and known gaps across a Go codebase?▼

To inventory technical debt across a Go codebase, scan source files and CI artifacts to locate TODO/FIXME/HACK comments, long functions over 100 lines, and packages missing tests, producing package-grouped counts and file references.

Can I automatically find TODO comments and refactor candidates in my repository?▼

Yes, you can automatically find TODO comments and refactor candidates by scanning repository source files to extract tagged comments like HACK and FIXME, and detecting functions exceeding 100 lines to prioritize cleanup efforts.

What is the best way to check for packages with low or missing test coverage before a cleanup sprint?▼

The best way to check for missing test coverage is to scan the repository's packages and CI artifacts to identify untested layers, producing a summarized inventory to guide your refactoring and testing priorities.

Does this technical debt scanner work with INTEGRATION-MATRIX.md files?▼

Yes, this technical debt scanner parses INTEGRATION-MATRIX.md files to list entities with partial warning statuses and identifies which integration layers are incomplete within your repository.

What are the limitations when scanning for code audit issues like long functions?▼

A limitation when scanning for code audit issues is that the process is read-only and primarily targets Go projects, meaning it produces inventory summaries without modifying code and may not cover non-Go languages comprehensively.

Related Skills

Explore More Software Engineering Skills→
brewpiratebrewpirate

scan

Generate model-scoped trigger phrases for files and directories.

Community
Advanced
cy-walicy-wali

tech-debt

Identify and prioritize technical debt with a scoring framework and remediation plan.

Community
Advanced
openshift-engopenshift-eng
112

Test Structure Analysis

Analyze Go test and source files to identify coverage gaps without executing tests.

Community
Advanced
Objective-ArtsObjective-Arts

qodana-scan

Run read-only Qodana static analysis to detect code issues.

Official
Intermediate