Avoid Drowning
0 likes945 views
The document provides tips for understanding a new code base by taking a top-down approach of first understanding the overall purpose and architecture before diving into specific components. It recommends starting with understanding the purpose, architecture, and then breaking the code base into components to understand each piece and how they fit together. Key steps include understanding the file hierarchy, dependencies, necessary tools, and potential challenges. Finding "lifesavers" like mentors, research resources, and additional readings can help ease the process of diving into a new code base.
Avoid Drowning
- 1. Avoid Drowning Swim your way through a new code base
- 2. LYNN ROOT Engineer @ Red Hat @roguelynn roguelynn.com
- 3. DIVING
- 5. Purpose Architecture Break it apart Lather, rinse, repeat
- 6. Purpose
- 7. What does it do? What problems does it solve? Strengths & weaknesses? Competitors?
- 8. Architecture
- 9. What are the components? How do pieces 鍖t together?
- 10. Break it apart
- 11. Whats this chucks purpose? How does it 鍖t with other components?
- 13. Go with the 鍖o敬
- 15. User
- 16. Target audience? How is it used? Learning curve?
- 17. Admin
- 18. How are users set up? How is it maintained? How does it work with their systems?
- 19. Manager
- 20. What are the goals? Release cycle & pressure dates? Other teams?
- 21. Developer
- 22. How to submit & 鍖x a bug? How is the code tested? Go-to people?
- 23. Ease in
- 24. File Hierarchy Dependencies Tools Challenges
- 25. File Hierarchy
- 26. Top-down Match up with architecture Docs, src, tests stdlib, modules, & third- party libraries
- 27. Dependencies
- 28. OS & hardware reqs Software reqs Build reqs
- 29. Tools
- 30. git log git blame git-by-a-bus
- 31. Challeges
- 32. Write docs Fix bugs Increase test coverage
- 33. Lifesavers
- 34. Mentor
- 35. Internal Mentor External Mentor Manager
- 36. Research
- 37. Personal/Private Wiki Bookmarks Old-fashioned post-its
- 38. Readings
- 39. The Pragmatic Programmer Cookbooks New Programmers Survival Guide The Developers Code
- 40. swim safely