timmy-home/templates/GENOME-template.md

GENOME.md — [org/repo]

Generated by pipelines/codebase_genome.py or used as a manual review scaffold when a human is curating the final artifact.

Project Overview

[One paragraph: what the repo does, why it exists, and what outcome it creates.]

• Text files indexed: [count]
• Source and script files: [count]
• Test files: [count]
• Documentation files: [count]

Architecture

graph TD
  repo_root["repo"] --> component_a["component-a"]
  repo_root --> component_b["component-b"]
  component_a --> component_b

Entry Points

• [path/to/entrypoint] — [why it matters] (python3 path/to/entrypoint.py)
• [path/to/other-entrypoint] — [why it matters] (bash path/to/script.sh)

Data Flow

1. [How operators or callers enter the system.]
2. [Which modules or directories fan out from the entrypoint.]
3. [Where validation or test gaps create risk.]
4. [What artifact, state change, or runtime side effect is produced.]

Key Abstractions

• [module.py] — classes [ClassName]:line; functions [function_name()]:line
• [another_module.py] — classes [AnotherClass]:line; functions [run()]:line

API Surface

• CLI: python3 [entrypoint] --help — [what it exposes]
• Python: [public_function]() from [module.py:line]
• HTTP/WebSocket/other: [surface] — [contract summary]

Test Coverage Report

• Source and script files inspected: [count]
• Test files inspected: [count]
• Coverage gaps:
  • [path/to/file] — [missing coverage detail]
  • [path/to/other] — [missing coverage detail]

Security Audit Findings

• [severity] [path:line] — [risk category]: [detail]. Evidence: [snippet]
• [severity] [path:line] — [risk category]: [detail]. Evidence: [snippet]

Dead Code Candidates

• [path/to/file] — [why it appears unreferenced]
• [path/to/other] — [why it appears unreferenced]

Performance Bottleneck Analysis

• [path/to/file] — [why runtime or scale could degrade here]
• [path/to/other] — [filesystem scan / network / large module / hot path detail]