Raw view: Onboard me to this repo
No invisible, zero-width, or bidi-control characters detected.
---
description: Build a map of this repository (commands, entry points, layers, data model, conventions, hotspots) and save it to a notes file
argument-hint: [notes path, default docs/ONBOARDING-NOTES.md] [focus area]
allowed-tools: Read, Grep, Glob, Write, Bash(git ls-files *), Bash(git log *), Bash(git shortlog *), Bash(wc *), Bash(sort *), Bash(uniq *), Bash(head *), Bash(awk *), Bash(sed *)
---
Onboard me to this repository. Notes path: $0 (default `docs/ONBOARDING-NOTES.md`). Focus area, if any: $1
Repository shape:
!`git ls-files | wc -l`
!`git ls-files | sed 's|/.*||' | sort | uniq -c | sort -rn | head -20`
!`git ls-files | awk -F. 'NF>1{print $NF}' | sort | uniq -c | sort -rn | head -10`
Recent activity:
!`git log --oneline -15`
!`git log --since=6.months --format= --name-only | sort | uniq -c | sort -rn | head -15`
Procedure (breadth first, roughly 15 minutes of reading):
1. Read, in order, whichever exist: README, CONTRIBUTING, CLAUDE.md or AGENTS.md, docs/ index, Makefile/justfile/package.json scripts, Dockerfile, CI workflow. Extract the exact install, build, test (full and single-file), lint, and run commands. Where two sources disagree, trust CI.
2. Find entry points (main/index/app/cmd/bin/routers) and follow one request or command end to end, naming each layer it crosses.
3. Locate the data model (schema, migrations, ORM models, protobuf/OpenAPI) and list the 5-10 core entities and their relationships.
4. Sample three files from different areas; note naming, error handling, logging, DI/wiring, and test layout.
5. If a focus area was given, spend the remaining time there and go one level deeper.
6. Write the notes file. If it exists, append a dated section instead of overwriting.
Notes file structure:
# Onboarding notes - <repo> - <date>
## One paragraph
## Commands (install / test / single test / lint / run)
## Map (table: area | path | notes)
## One request, end to end
## Core entities
## Conventions
## Hotspots (from the churn list above)
## Open questions
Reply with: the notes path, the one-paragraph summary, the commands block, and the open questions. Keep the detail in the file.