I believe that contributing to an open source project is essential for any developer, contributing is very rewarding and it brings many benefits for you as a developer.
- Improve your skills
- Find mentors and teach others
- Grow your career
These are just a few of the perks and I'll not go deeper into the benefits of contributing to open source projects, I assume that anyone who's reading this article is aware of them and is trying to make a contribution.
The truth is that it took me a long time to make my first contribution, far more I'd have liked to, I've been aware of Open Source for a long time and been wanting to contribute for almost a year. I know, contributing to open source can be intimidating and daunting so I'd like to share my experience and this little guide so many developers take the step earlier, overcome this fears and get started in the amazing world of Open Source.
This guide is intended for developers looking to contribute code but remember that code is just one of many ways you can contribute to open source projects.
Before anything I recommend to cover a few basic concepts you'll need to make your first contribution, I'm talking about the basic steps to make a contribution.
- Fork the repository, clone it and set up your environment.
- Create a branch for your edits.
- Code and test.
- Provide documentation of your contribution.
- Submit a Pull Request
I understand this process can be overwhelming, especially if you haven't done it before but there are plenty of tutorials and guides about this online.
Here's a great GitHub repository, First Contributions, which guides you through the full process, and gives you the opportunity to apply it in a practice environment. It is very well documented and very easy to follow, it will help you gain the confidence you'll need for the real deal.
Pick a Project
Ok, now you need to find a project you'd like to contribute to, I believe it's important to select a project you genuinely are interested in, it's a huge satisfaction to be able to contribute to a mission you believe in.
There are plenty of Open Source projects of many kinds so take your time and start looking, I'm pretty sure you are already using an open source project in your daily life and I think this is one of the best options since you'll surely already know the project and are familiar with the mission of it.
Here are a few resources where you can explore open source projects.
- GitHub Explore
- Open Source Friday
- First Timers Only
- 24 Pull Requests
- Up For Grabs
- First Contributions
In my personal experience I choose Simplenote for Android, Simplenote is the simplest way to take notes, a light, clean and free available for iOS, Android, Mac, Windows, Linux and the web supported by Automattic.
Pick One Issue
Now you need to find a bug/feature where you can help and you'll need patience for this, most probably you'll not find the perfect easy but meaningful bug/feature waiting for you, be prepared to spend some time reading through the bugs/features available, getting to know the problems and making sure you'll be able to help.
Some repos make this task easier by using some tags for you to identify which issues could be a good fit like help wanted and good first issue.
Get the Context
Based on my experience you may be in need of additional information in order to be able to fix the issue you selected. Don't be afraid to ask but be patient, many projects have official communication channels so be sure to search for this in the repository docs. I'm pretty sure current contributors will be happy to help you.
Now, you're all set to hack the project and contribute, once you've finished you'll need to open your Pull Request and follow it closely until it is merged and closed.
Most probably you'll receive comments and requests, don't feel bad about them, that's the magic of open source, you'll learn and discuss the best way to do things and hopefully after a little back and forth your code will be merged and shipped into the next release.
Top comments (4)
This is such an amazing article! Thank you a million for writing this!!!
Thanks Elena! :)
Thanks For Sharing.Amazing Article
Thanks for reading deepak! :)