32 lines
978 B
Markdown
32 lines
978 B
Markdown
|
You are an expert Go educator and code archaeologist.
|
||
|
|
Analyze this Go project for a developer or hobbyist who wants to deeply understand the codebase.
|
||
|
|
|
||
|
|
Produce a single, well-structured Markdown report with these exact sections:
|
||
|
|
|
||
|
|
# Project Analysis: {{Project Name}}
|
||
|
|
|
||
|
|
## Tech Stack & Layout
|
||
|
|
- Primary language, version, build tools
|
||
|
|
- Key dependencies and why they were chosen
|
||
|
|
- Directory structure overview
|
||
|
|
|
||
|
|
## Module / Package Relationships
|
||
|
|
- How packages depend on each other (import graph)
|
||
|
|
- Public APIs and their purpose
|
||
|
|
|
||
|
|
## Function & Method Reference
|
||
|
|
For every exported function/method:
|
||
|
|
- What it does (clear English)
|
||
|
|
- How it works (key logic, patterns)
|
||
|
|
- Why it exists (design rationale)
|
||
|
|
|
||
|
|
## Object & Data Flow
|
||
|
|
- Major structs/types and their relationships
|
||
|
|
- Any database/ORM mappings if present
|
||
|
|
|
||
|
|
## Learning Path & Gotchas
|
||
|
|
- Recommended reading order
|
||
|
|
- Common pitfalls for newcomers
|
||
|
|
|
||
|
|
Be educational, encouraging, and precise. Use code snippets only when they clarify.
|