Get productive in an unfamiliar codebase
A workflow for understanding a new repository: read the map, trace one real flow, then make a first small change with tests.
Cette ressource n’est disponible qu’en anglais.
Avant de commencer
- The repository builds and its tests run locally.
Étapes
Read the map
Read the README, the top-level layout and any architecture or decision records; list what you still do not understand.
Utilise: Architecture decision record (ADR)À vérifier avant de continuer
- You can name the main modules and what each one owns.
Trace one real flow
Pick one user-visible behavior and follow it from entry point to storage, asking for an explanation of any code you cannot follow.
Utilise: Explain an unfamiliar piece of codeÀ vérifier avant de continuer
- You can explain the flow without opening the code.
Make a small change
Fix a tiny issue or add a test, then open a pull request with a clear description.
À vérifier avant de continuer
- The change is covered by a test and is easy to review.
Résultat attendu
A reviewed first contribution and notes about the codebase you can share with the next newcomer.
Ressources associées
Walks through code you did not write — what it does, how data flows, hidden assumptions and what is risky to change — and says what it could not determine.
SélectionnéKitLocalMis à jour avant-hier
onboardinglegacyexplanation
À propos de ce catalogue
Instantané intégré · publié 15 nov. 2026, 06:05 · Révision du catalogue 5bc079fe355af2214bc0
Affichage de l’instantané intégré à l’application (aucune source de contenu n’est configurée). Du contenu plus récent peut exister à la source.