3 ms·
If the project is small (just a handful of files), then I will just jump directly to the code. But if it's medium to large (several folder, tens or hundred fil
by letientai299 7y ago
If the project is small (just a handful of files), then I will just jump directly to the code.
But if it's medium to large (several folder, tens or hundred files), then I prefer "working" with the code more than just read it.
The process usually follows this order:
- Check the document for how to build and run the test. Make sure test passes before doing anything else.
- Once test pass, go back to the document, look for the program entry point (if it's built into a binary), or the exposed interface (if it's library). Skim through that to get the overview.
- Load the project into my IDE, and try debug the test to understand the flow. Sometimes, I'll also write new code to check my understanding.
That said. If the goal of reading that OSS project is to hunt down a bug, I would just start from my own code, and debug into the library itself. Skip the overview part.