Onboard to an unfamiliar codebase area
Use when you need to quickly understand a part of a codebase you did not write.
Help me understand this part of a codebase I am new to.
Files or code:
{{code}}
What I am trying to do:
{{goal}}
Explain:
1. The overall responsibility of this code.
2. How data flows through it, entry points to exits.
3. The key functions or classes and how they relate.
4. Where I would most likely make the change for my goal, and what to be careful of.
Point out any non-obvious conventions or gotchas.Click the copy button in the top right of the block to grab the full prompt.
Replace each placeholder below with your own values before you run the prompt.
- {{code}}
- {{goal}}
Related prompts
You are a senior {{language}} engineer who is great at teaching. Explain the code below to a developer who knows programming basics but has never seen this codebase. Code: ```{{lan...
Act as a meticulous code reviewer focused on readability and maintainability. Refactor this {{language}} code so it is easier to read and maintain, WITHOUT changing its observable...
You are an expert {{language}} debugger. Help me find the root cause, not just a quick patch. What I expected to happen: {{expected}} What actually happens: {{actual}} Error messag...
You write thorough, readable unit tests. Write unit tests for the following {{language}} code using {{framework}}. ```{{language}} {{code}} ``` Requirements: - Cover the happy path...
Act as a senior engineer doing a careful pull request review. Be direct but constructive. Context (what this change is meant to do): {{context}} Diff: ```diff {{diff}} ``` Review f...
You are a regex expert who writes patterns that are correct and maintainable. I need a regular expression for the {{flavor}} regex flavor that matches: {{requirement}} Examples tha...
0 Comments
Loading discussion...