Contributing to Open-Source Walkthrough Part 0

Working on open source can feel like adding or fixing a gear in a complex machine (Image by Digital Buggu)

There are quite a few guides on the Internet on how to contribute to open source, but none so far I’ve seen that walks through the whole process of an open source contribution (Whole process as in finding an open source repo to contribute to, to getting your contribution merged in). As I write this article, I will be thinking out loud and following my own steps from start to finish.

I made this guide because I’m a person who loves to learn by looking at examples, watching YouTube videos of how people do things, compared to reading instructions or documentation. Hopefully, this walkthrough can help you make your first code contribution, even if other guides haven’t.

This guide is great if you just want to contribute to open source. Whether you want to become a better developer, build your resume, or just want to get involved, these are all great reasons.

Overview of Steps

Choose an Open Source Project and Issue (Part 1)

1. Find or create a list of semi-popular and popular open source projects.
2. Narrow down list based on project activity, beginner-friendliness, and project fit
3. Pick one issue and ask to work on it

Working on the Issue (Part 2)

1. Fork the repo and make a new branch for your PR
2. Get a high-level understanding of the code base
3. Run the project locally
4. Add the fix/feature, test extensively and write tests if necessary
5. Clean up the code

Opening and Merging the PR (Part 3)

1. Open a PR on Github
2. Follow the repo’s appropriate steps to write the PR
3. Reference the open issue
4. Make any requested changes to your PR

Begin reading Part 1 here ->