b8b8bb65fd
Template and analyzer for the Codebase Genome batch (issues #667-683). templates/GENOME-template.md: Reusable template with placeholders for repo name, overview, architecture, entry points, data flow, abstractions, API surface, test coverage, security, and design decisions. scripts/genome_analyzer.py: Auto-generates GENOME.md skeleton from a codebase scan: - File counts by extension - Directory structure (depth 2) - Entry point detection (main.py, scripts/, Makefile, etc.) - Test file enumeration - README first-paragraph extraction Usage: python3 scripts/genome_analyzer.py /path/to/repo --output GENOME.md python3 scripts/genome_analyzer.py /path/to/repo --dry-run
47 lines
543 B
Markdown
47 lines
543 B
Markdown
# GENOME.md — {{REPO_NAME}}
|
|
|
|
> Codebase analysis generated {{DATE}}. {{SHORT_DESCRIPTION}}.
|
|
|
|
## Project Overview
|
|
|
|
{{OVERVIEW}}
|
|
|
|
## Architecture
|
|
|
|
{{ARCHITECTURE_DIAGRAM}}
|
|
|
|
## Entry Points
|
|
|
|
{{ENTRY_POINTS}}
|
|
|
|
## Data Flow
|
|
|
|
{{DATA_FLOW}}
|
|
|
|
## Key Abstractions
|
|
|
|
{{ABSTRACTIONS}}
|
|
|
|
## API Surface
|
|
|
|
{{API_SURFACE}}
|
|
|
|
## Test Coverage
|
|
|
|
### Existing Tests
|
|
{{EXISTING_TESTS}}
|
|
|
|
### Coverage Gaps
|
|
{{COVERAGE_GAPS}}
|
|
|
|
### Critical paths that need tests:
|
|
{{CRITICAL_PATHS}}
|
|
|
|
## Security Considerations
|
|
|
|
{{SECURITY}}
|
|
|
|
## Design Decisions
|
|
|
|
{{DESIGN_DECISIONS}}
|