Explain This Folder Like I'm New on the Team
Get a newcomer's tour of an unfamiliar part of a codebase: what lives where, how data flows and what not to touch.
I just joined a team and I'm reading this part of the codebase for the first time.
Here are the files from {{folder or module name}}:
{{paste files, each starting with its path}}
Explain it like a helpful teammate on my first day:
1. What this module is for, in two sentences.
2. A map: each file in one line, grouped by role.
3. How a typical request or job flows through it, step by step,
naming the functions involved.
4. The three things most likely to confuse a newcomer.
5. Anything that looks fragile, surprising or "don't touch this",
with your reasoning.
Only describe what's actually in the code. If something depends on files
I haven't shown you, say which ones you'd want to see next.2 fill-in fields: Folder or module name, Paste files, each starting with its path