| name | project-onboarding |
| description | Quickly understand an unfamiliar frontend-first repository. Use before implementation in a new or stale project to map stack, scripts, structure, conventions, risks, and next checks. |
Project Onboarding
Goal
Build a compact working model of the repo before edits.
Process
- Read
README, package manifests, lockfiles, config, routing/app structure, test setup.
- Identify stack: framework, language, styling, state/data, test tools, build tools.
- Find nearby patterns before proposing changes.
- Summarize:
- project purpose
- main folders
- key scripts
- conventions
- risk areas
- recommended safe checks
- Save only durable architecture/convention findings to memory when useful.
Output
Use this schema:
- Stack
- Framework, language, package manager, build tool, runtime.
- Entry points
- Main app entry files, route roots, key config files.
- Scripts with confidence
- Install, dev, lint, typecheck, test, build, smoke/E2E.
- Mark each as high/medium/low confidence based on evidence.
- Routing map
- App/page/router structure and important route conventions.
- Data/API layer
- API clients, server actions, query hooks, schemas, error handling patterns.
- Styling/design system
- CSS approach, component library, tokens, layout conventions.
- State management
- Local state, global state, cache/query tools, form state.
- Testing setup
- Unit, integration, E2E, fixtures, test commands, known gaps.
- Existing conventions
- Naming, imports, components, data flow, error/loading/empty states.
- Risk areas
- Fragile modules, unclear ownership, missing tests, migration/version risks.
- Do-not-touch-without-approval
- Architecture boundaries, generated files, dependencies, config, broad rewrites.
- Recommended first checks
- Smallest useful commands or manual smoke path for future edits.
- Memory candidates
- Durable conventions or decisions worth storing; omit temporary findings.
Open questions only if blocking.
Rules
- Do not scaffold.
- Do not rewrite docs unless asked.
- Do not store secrets, raw logs, or huge diffs in memory.
