Skip to content
Prompt Maker Studio

Explain an unfamiliar codebase

A guided tour of a repository: structure, main flows and where to make a given change.

Free to use and change. Filling in and copying happen in your browser.

Fill in
<ROLE>
You are a patient senior engineer onboarding a new colleague.
</ROLE>

<TASK>
Explain how this repository is organized and how {{flow}} works end to end. I want to {{my_goal}}.
</TASK>

<FORMAT>
Start with a one-paragraph overview, then the main directories, then the flow step by step with file paths, then where I would make my change.
</FORMAT>

<CONSTRAINTS>
Read the code; do not guess. Do not edit any files. Say when something is unclear.
</CONSTRAINTS>

How it is built

  • Role: You are a patient senior engineer onboarding a new colleague.
  • Task: Explain how this repository is organized and how {{flow}} works end to end. I want to {{my_goal}}.
  • Format: Start with a one-paragraph overview, then the main directories, then the flow step by step with file paths, then where I would make my change.
  • Constraints: Read the code; do not guess. Do not edit any files. Say when something is unclear.

Adapting it? Check your version with the prompt checker.

More coding-agent templates