Skip to content

AGENTS.md

Latest commit

 

History

History
99 lines (70 loc) · 4.39 KB

AGENTS.md

File metadata and controls

99 lines (70 loc) · 4.39 KB
Raw

SIN-Code-IBD-Tool — Intent-Based Diffing — semantic code-diff that reports structural changes (function added, parameter removed, class renamed) instead of raw line deltas.

Architecture

Parses Python source into ASTs, walks them recursively, and emits stable change-type strings (e.g. function_added, parameter_removed). Single-language by design (Python only). Main entry point: src/ibd/cli.py (Typer, single diff subcommand). Consumed by code-review agents and sin code ibd.

Services

Service Port Purpose
CLI N/A ibd diff — semantic AST diff

Quick-Start

pip install -e .
ibd --help
ibd diff tests/fixtures/before.py tests/fixtures/after.py

Key Endpoints / Commands

  • ibd diff — compute semantic diff between two Python files

CoDocs

  • All Python source files in src/ibd/ MUST have a .doc.md companion.
  • Run sin codocs check to validate. Output MUST be OK: 2 files to pass.
  • CoDocs companion for THIS file: none (AGENTS.md is itself a doc).

Testing

pytest tests/ -v
pytest tests/test_agents_md.py -v

Expected: 6 tests pass (5 existing + 1 from issue #40).

Integration

  • sin-code HubTool: sin code ibd diff — called by code-review agents.
  • MCP server: ibd exposes MCP via the sin-code serve adapter; the tool prefix in MCP namespace is ibd__* (e.g. ibd__diff).
  • Cross-repo: consumed by code-review agents and the sin code ibd HubTool.

GitNexus — Code Intelligence

This project is indexed by GitNexus as SIN-Code-IBD-Tool (138 symbols, 171 relationships, 4 execution flows). Use the GitNexus MCP tools to understand code, assess impact, and navigate safely.

If any GitNexus tool warns the index is stale, run npx gitnexus analyze in terminal first.

Always Do

  • MUST run impact analysis before editing any symbol. Before modifying a function, class, or method, run gitnexus_impact({target: "symbolName", direction: "upstream"}) and report the blast radius (direct callers, affected processes, risk level) to the user.
  • MUST run gitnexus_detect_changes() before committing to verify your changes only affect expected symbols and execution flows.
  • MUST warn the user if impact analysis returns HIGH or CRITICAL risk before proceeding with edits.
  • When exploring unfamiliar code, use gitnexus_query({query: "concept"}) to find execution flows instead of grepping. It returns process-grouped results ranked by relevance.
  • When you need full context on a specific symbol — callers, callees, which execution flows it participates in — use gitnexus_context({name: "symbolName"}).

Never Do

  • NEVER edit a function, class, or method without first running gitnexus_impact on it.
  • NEVER ignore HIGH or CRITICAL risk warnings from impact analysis.
  • NEVER rename symbols with find-and-replace — use gitnexus_rename which understands the call graph.
  • NEVER commit changes without running gitnexus_detect_changes() to check affected scope.

Resources

Resource Use for
gitnexus://repo/SIN-Code-IBD-Tool/context Codebase overview, check index freshness
gitnexus://repo/SIN-Code-IBD-Tool/clusters All functional areas
gitnexus://repo/SIN-Code-IBD-Tool/processes All execution flows
gitnexus://repo/SIN-Code-IBD-Tool/process/{name} Step-by-step execution trace

CLI

Task Read this skill file
Understand architecture / "How does X work?" .claude/skills/gitnexus/gitnexus-exploring/SKILL.md
Blast radius / "What breaks if I change X?" .claude/skills/gitnexus/gitnexus-impact-analysis/SKILL.md
Trace bugs / "Why is X failing?" .claude/skills/gitnexus/gitnexus-debugging/SKILL.md
Rename / extract / split / refactor .claude/skills/gitnexus/gitnexus-refactoring/SKILL.md
Tools, resources, schema reference .claude/skills/gitnexus/gitnexus-guide/SKILL.md
Index, status, clean, wiki CLI commands .claude/skills/gitnexus/gitnexus-cli/SKILL.md