Ask HN: How do you learn a massive codebase?

Posted by ilovecaching on Wednesday March 30, 2022 @05:03PM
from the ask-hn dept.

Kernels, browsers, schedulers, etc. often easily reach the 100k-1m+ LoC mark. What strategies do you employ to understand the high level architecture and begin contributing in a meaningful way? What tools do you use? What is your thought process? How do you get up to the same speed as the developers who have been working on the project already for years if not decades so that you can become an equal contributor?

( 7 comments | 12 points | on HN )

Re:Ask HN: How do you learn a massive codebase? by iamstupidsimple on Thursday March 31, 2022 @04:00AM (#30864899)

Figure out the core data structures and do this at different level of abstraction. I'm currently reading through bits of the TensorFlow codebase, and starting with TF's GraphDef[0] was a good place to start. This is great because it's high-level enough that I can understand how TF models are structured on-disk and I can follow the deeper threads (e.g. how does device acceleration work) if needed.

https://github.com/tensorflow/tensorflow/blob/master/tensorf...

[ Parent | on HN ]

Re:Ask HN: How do you learn a massive codebase? by tyroh on Wednesday March 30, 2022 @07:04PM (#30861948)

1. If the original authors are still around, we do a knowledge transfer. 2. Create diagrams about the relationships between all the systems involved. UMLs, ERDs, and all the rest of them 3. Clone the system locally and trace how the data flows from one point to the next. I'd go with logins first since we all know how it should work so it's easy to follow. 4. Lots and lots of trial and error when contributing new features. If it's well made, tests will catch your bugs. If you have a good team, they'll cut you some slack since you're just new and they were also new, too.

[ Parent | on HN ]

Re:Ask HN: How do you learn a massive codebase? by karmakaze on Wednesday March 30, 2022 @11:44PM (#30863614)

Go deep. Find something interesting and pull on that thread and keep going until you figure something out. If you do/don't get that far, start changing some things and see how it (mis)behaves, iterate.

[ Parent | on HN ]

Re:Ask HN: How do you learn a massive codebase? by db48x on Wednesday March 30, 2022 @07:09PM (#30861994)

The same way you eat an elephant: one bite at a time.

[ Parent | on HN ]

Re:Ask HN: How do you learn a massive codebase? by goy on Thursday March 31, 2022 @09:26AM (#30866890)

I don't think so. If you want to eat an elephant, eat it in group. :-)

[ Parent | on HN ]

Re:Ask HN: How do you learn a massive codebase? by goy on Thursday March 31, 2022 @09:24AM (#30866868)

Check this: https://mitchellh.com/writing/contributing-to-complex-projec...

[ Parent | on HN ]

Re:Ask HN: How do you learn a massive codebase? by Flankk on Wednesday March 30, 2022 @05:27PM (#30860996)

Talk to the people who understand it well. Unless it is extremely well documented that is the only sane method. If you can get a class diagram it will help.

[ Parent | on HN ]