OpenParable
Skip to content
← Back to skills

Code Health Check

Testing & Quality
code-health-check

Code Health Check is an Agent Skill for testing & quality published in the huangjia2019/claude-code-engineering repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.

Perform a comprehensive code health check on a directory. Use when the user asks to analyze code quality, find issues, or get a health report.

View on GitHub ↗
QUICK START

How to use this skill

Bring this guide into your coding agent with a prompt tailored to the tool you use.

  1. Open your project in Codex.
  2. Copy and paste the prompt below.
  3. Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/huangjia2019/claude-code-engineering/blob/HEAD/04-Skills/projects/07-skill-fork-demo/.claude/skills/code-health-check/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/code-health-check, but wait for my approval before writing files or running scripts.

Copying this prompt does not install or run the skill. Review third-party files before use.

Code Health Check

Analyze the codebase at $ARGUMENTS and produce a structured health report.

Checks to Perform

1. File Organization

  • Are files reasonably sized? (Flag files > 200 lines)
  • Is the directory structure logical?
  • Any files that look misplaced?

2. Error Handling

  • Are async operations wrapped in try/catch?
  • Are errors propagated correctly (not swallowed)?
  • Is there a global error handler?

3. Security Basics

  • Any hardcoded secrets, API keys, or passwords?
  • Any use of eval() or similar dangerous functions?
  • Are user inputs validated before use?

4. Code Quality

  • Any obvious code duplication (similar blocks in multiple files)?
  • Any unused variables or imports?
  • Are function signatures reasonable (not too many parameters)?

5. Dependency Hygiene

  • Are all imported modules actually used?
  • Any circular dependencies?

Severity Levels

Use these to categorize issues:

SeverityMeaningExample
CRITICALMust fix immediatelyHardcoded secrets, SQL injection
WARNINGShould fix soonMissing error handling, large files
INFONice to improveMinor duplication, naming conventions

Output Format

Return a structured report in this exact format:

# Code Health Report: {directory}

## Overall Score: {A/B/C/D/F}

## Summary
- Files analyzed: {count}
- Issues found: {critical} critical, {warning} warnings, {info} info

## Critical Issues
{list each with file:line and description}

## Warnings
{list each with file:line and description}

## Info
{list each with file:line and description}

## Recommendations
{top 3 actionable recommendations}