Project Overview
Produce a concise, human-readable summary of this project for someone new to the codebase.
Steps
- Identity: Read
README.md(if present) for the stated purpose. If absent, infer from directory names and key files. - Structure: List top-level directories and files. Note the dominant language(s) and any obvious architecture layers (frontend, backend, infra, tests, docs).
- Recent activity: Run
git log --oneline -10to show the last 10 commits. Summarize what areas have been changing. - Open work: Look for
TODO,FIXME, orHACKcomments withgrep -r "TODO\|FIXME\|HACK" --include="*.md".and note how many exist. - Key entry points: Identify the main entrypoint files (e.g.
main.*,index.*,app.*,Makefile,package.json,Cargo.toml).
If $ARGUMENTS is provided, focus the overview on that area or topic instead of the whole project.
Output format
- Purpose: one sentence
- Stack: languages, frameworks, key dependencies
- Structure: bullet list of top-level dirs with one-line descriptions
- Recent activity: what's been changing (based on git log)
- Entry points: files to start reading
- Open items: count of TODOs/FIXMEs, any that look urgent
Keep the output under 30 lines. Prioritize clarity over completeness.