agentleFS
jmylchreestjmylchreest/aide/skills/debug/SKILL.md

debug

Skill19 starsChanged 3 months agoMITView on GitHub

Systematic debugging workflow for tracking down bugs and issues

192 other projects use a version of this.

Adopted by

Most recently taken up by

Used with

Projects with it also use add-discord, add-slack and 10 more.

Other files people use alongside this one.

Files found in the same public projects as a version of this one, more often than they turn up anywhere else. Each project counts once, large collections count for less, and this file's own repository is left out.
  • MicrosoftSkill

    add-discord

    Add Discord bot channel integration via Chat SDK.

    Also in 11 projects that use this

  • MicrosoftSkill

    add-slack

    Add Slack channel integration via Chat SDK.

    Also in 11 projects that use this

  • +10 more from microsoft

The file

Show its rules and text

We split this skill into the rules it gives an agent

23 rules. 0 are common, 19 are distinctive, and 4 are very specific to this project.

  • 0

    Common

    Most of the 175 edited versions we read keep these.

  • 19

    Distinctive

    This author's own choices. Worth a look.

  • 4

    Very specific

    Tied to their project's names, files or tools. Probably skip.

  • Common
  • Distinctive
  • Very specific
  1. Distinctive:

    Look for race conditions

    line 49
  2. Distinctive:

    Check for cached state

    line 50
  3. Distinctive:

    Use tools to find code related to the error:

    line 54
  4. Distinctive:

    Follow the code flow from entry to error:

    line 72
  5. Distinctive:

    Read the failing function or known stack-trace ranges directly

    line 74
  6. Very specific:

    Use code_references to find callers of the failing function

    line 75
  7. Very specific:

    Read the relevant execution path.

    line 76
  8. Very specific:

    Check type definitions with code_search kind="interface"

    line 78
  9. Distinctive:

    Read the full file when it is small or most contents are needed.

    line 80
  10. Distinctive:

    Test each hypothesis systematically:

    line 98
  11. Distinctive:

    Check variable values at key points

    line 113
  12. Distinctive:

    Verify assumptions about input data

    line 114
  13. Distinctive:

    Test edge cases (null, empty, boundary values)

    line 115
  14. Distinctive:

    Don't refactor unrelated code

    line 123
  15. Distinctive:

    Add null/undefined check

    line 128
  16. Distinctive:

    No new errors introduced

    line 151
  17. Distinctive:

    When abandoning an approach: If you try a fix direction and abandon it (e.g., revert because it causes regressions), record it as an …

    line 163
  18. Distinctive:

    Always get the full error message and stack trace first

    line 214
  19. Distinctive:

    Don't guess - trace the code path methodically

    line 215
  20. Distinctive:

    Remove temporary logging before committing

    line 217
  21. Distinctive:

    Consider if the bug could occur elsewhere

    line 218
  22. Distinctive:

    When storing memories from this skill (abandoned approaches, blockers), always:

    line 222
  23. Very specific:

    Verify codebase claims: before storing — If a memory references a file, function, or path, confirm it exists first.

    line 226

“Common” is measured: kept by at least 6 in 10 of the 175 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.

Keep what fits and drop the rest. Your version, ready for your agents.
Files
SKILL.md

Debug Mode

Recommended model tier: smart (opus) - this skill requires complex reasoning

Systematic approach to identifying and fixing bugs.

Prerequisites

Before starting:

  • Get the exact error message or unexpected behavior description
  • Identify the entry point or trigger for the bug
  • Note any relevant environment details (Node version, OS, etc.)

Workflow

Step 1: Reproduce the Issue

Goal: Confirm the bug exists and understand its behavior.

# Run the failing code/test
npm test -- --grep "failing test"
# OR
node path/to/script.js

Document:

  • Exact error message
  • Steps to trigger
  • Expected vs actual behavior
  • Is it consistent or intermittent?

If cannot reproduce:

  • Check environment differences
  • Look for race conditions
  • Check for cached state

Step 2: Locate the Relevant Code

Use tools to find code related to the error:

# Search for function mentioned in stack trace
mcp__plugin_aide_aide__code_search query="functionName" kind="function"

# Navigate an unfamiliar large suspect file when its structure is needed
mcp__plugin_aide_aide__code_outline file="path/to/file.ts"

# Get symbols in suspect file
mcp__plugin_aide_aide__code_symbols file="path/to/file.ts"

# Search for error message text in code
Grep for "error message text"

Step 3: Trace the Execution Path

Follow the code flow from entry to error:

  1. Read the failing function or known stack-trace ranges directly
  2. Use code_references to find callers of the failing function
  3. Read the relevant execution path; use code_outline when unfamiliar large-file structure would help locate the next section, or batch known symbols with code_read_symbol
  4. Check type definitions with code_search kind="interface"

Read the full file when it is small or most contents are needed. Extra navigation rounds can outweigh smaller responses; use outlines when they resolve missing context.

Step 4: Form Hypotheses

Based on the error type, consider these causes:

SymptomLikely Causes
"undefined is not a function"Variable is null/undefined, wrong import
"Cannot read property of undefined"Missing null check, async timing issue
"Type error"Type mismatch, wrong function signature
"Maximum call stack"Infinite recursion, circular reference
"Network error"Bad URL, CORS, timeout, server down
"State not updating"Mutation instead of new object, missing dependency

Step 5: Validate Hypotheses

Test each hypothesis systematically:

# Add temporary logging
console.log('DEBUG: variable =', JSON.stringify(variable));

# Check with debugger
node --inspect-brk script.js

# Run specific test
npm test -- --grep "test name"

Validation checklist:

  • Check variable values at key points
  • Verify assumptions about input data
  • Test edge cases (null, empty, boundary values)
  • Check async ordering

Step 6: Apply the Fix

Rules:

  • Change only what's necessary to fix the bug
  • Don't refactor unrelated code
  • Match existing code patterns

Common fixes:

  • Add null/undefined check
  • Fix type annotation
  • Correct async/await usage
  • Fix variable scope
  • Add missing initialization

Step 7: Verify the Fix

# Run the originally failing test/scenario
npm test -- --grep "failing test"

# Run related tests
npm test -- --grep "related feature"

# Run full test suite to check for regressions
npm test

Verification criteria:

  • Original issue no longer occurs
  • Related tests still pass
  • No new errors introduced

Failure Handling

SituationAction
Cannot reproduceCheck environment, add logging to narrow down
Multiple bugs intertwinedFix one at a time, verify after each
Fix causes new failuresRevert, analyze dependencies, try different approach
Root cause is in dependencyCheck for updates, file issue, implement workaround
Bug is in async codeAdd proper await, check Promise chains

When abandoning an approach: If you try a fix direction and abandon it (e.g., revert because it causes regressions), record it as an abandoned approach so future sessions don't repeat it:

./.aide/bin/aide memory add --category=abandoned \
  --tags=reason:<why>,approach:<what>,project:<name>,session:<id>,source:discovered \
  "ABANDONED: <what was tried>. REASON: <why>. ALTERNATIVE: <new direction>. CONTEXT: <details>"

MCP Tools

  • mcp__plugin_aide_aide__code_outline - Navigate unfamiliar large files when their structure is needed
  • mcp__plugin_aide_aide__code_search - Find functions, classes, types involved in the bug
  • mcp__plugin_aide_aide__code_symbols - List all symbols in a file
  • mcp__plugin_aide_aide__code_references - Find all callers of a function
  • mcp__plugin_aide_aide__memory_search - Check for related past issues

Output Format

## Debug Report: [Issue Title]

### Problem

[What was happening vs what should happen]

### Reproduction

[Steps to reproduce the issue]

### Root Cause

[Identified cause with file:line reference]
[Why the bug occurred]

### Fix Applied

[What was changed and why]

### Verification

- Original issue: FIXED
- Related tests: PASS
- Full suite: PASS

### Prevention

[Optional: How to prevent similar bugs]

Tips

  • Always get the full error message and stack trace first
  • Don't guess - trace the code path methodically
  • One fix at a time - don't bundle unrelated changes
  • Remove temporary logging before committing
  • Consider if the bug could occur elsewhere

Memory Hygiene

When storing memories from this skill (abandoned approaches, blockers), always:

  1. Include source: tag — Use source:discovered for things you found, source:inferred for deductions
  2. Include scope tags — Add project:<name>,session:<id> (get project name from git remote or directory; session ID from $AIDE_SESSION_ID or $CLAUDE_SESSION_ID)
  3. Verify codebase claims before storing — If a memory references a file, function, or path, confirm it exists first. See the memorise skill for the full verification workflow.
  4. Never use scope:global unless storing a user preference

Download now (ZIP)

Does it work?

Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.

No reviews yet

People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.

  • It worked
  • Partly
  • It didn't
What did you use it for? e.g. Reviewing pull requests in a Rails app

Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.

Your trail

Files you open will collect here, so you can find them again.

Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.

Now do this for your own.

Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.