You have access to this repository. Produce an onboarding note for an engineer joining tomorrow. Constraints: 400 words max, no marketing language, written for someone who will be fixing bugs by Thursday.
Sections, in this order:
- What it does — two sentences, in terms of users, not tech.
- How a request flows — from the entry point to the database and back, naming the actual files/functions in order. One line per hop.
- The three places bugs actually live — based on git history (
git log --stat), which files change most often and why. - Things that look wrong but are intentional — anything with a comment like “don’t change this”, a workaround, or a weird config value; explain each in one line.
- How to run it and run the tests — exact commands, copied from the scripts, not paraphrased.
- Who to ask — from CODEOWNERS or commit authors, per area.
If you cannot verify a claim from the code, mark it “(unverified)”.
Comments (0)
No comments yet.
Sign in to comment.