Understand a Repository
Before you touch any code, spend five minutes figuring out how the project is organized.
What you'll learn
The README explains what a project does. CONTRIBUTING.md documents the exact workflow maintainers expect, so always read it before opening a pull request. Beyond that, a quick look at the folder structure, open issues, and past pull requests tells you almost everything else you need to get started.
Do this
- Read the practice repository's README.
- Read CONTRIBUTING.md. It's the rulebook for how contributions get made here.
- Skim the
src/andtests/folders so you know where code and tests live. - Open a couple of past pull requests to see what a real one looks like.
Try it
Find the function chunk() in the repository, then find the test file that covers it.
Check your work
You can say where the source code lives, where the tests live, and what command runs the tests.