Join the 85,000 open source advocates who receive our giveaway alerts and article roundups.
Becoming an open source developer
A developer's guide to getting into open source
Get the newsletter
Want to contribute to an open source project, but don't know where to start? Finding the first problem to fix in an unfamiliar codebase can seem pretty difficult—and even more so if it counts millions of lines of code—but it's usually much easier than it looks. This article should give you a few tips and ideas on how to get started.
Developers contribute to open source projects for a variety of reasons. Some want to fix a bug or add a missing feature, while others are looking to gain experience or for a chance to work with an interesting technology. Whatever your reason is, make sure you pick a project that you care about and use yourself. You may end up spending a considerable amount of time working on it, and relating to the project will help you stay motivated.
Set up your dev environment
Before you can contribute any code to a project, you'll need to be able to compile it, test, and debug on your computer. Setting up the dev environment is also a good first step to acquainting yourself with the codebase.
Clone the project's repository and see how you can do that. Usually, there will be specific instructions in the project's ‘README’ file. Install all the tools and dependencies and configure your system. If there are automated tests, make sure you can run them.
This can be awfully simple for smaller projects. You may not even need to do anything at all if you're dealing with an interpreted language. On the other hand, it's likely to take a while if you're compiling the Linux Kernel, GTK, or a similar-sized application for the very first time.
Getting grips with the build system is very important. You'll be able to experiment with the code, change it, and see what happens. It will also make it much easier for you to understand what people are talking about.
Get in the loop
Join the mailing list, visit the IRC channel, see the bug tracker, and read the project wiki. There are many ways in which the teams behind open source projects communicate. Be where the developers are. You don't need to participate yourself if you don't want to, just see what's going on.
Chances are that the communication will make more sense if you're a user of the application yourself, and if you've set up the dev environment and tried compiling it.
Joining a mailing list for a large project can bring tens or even hundreds of emails into your inbox every day. Many of them will be patches or make no sense whatsoever. Don't worry about that, and certainly don't feel obliged to read them all. Watch how the developers work and you'll slowly start figuring it all out.
Get in touch
When you've been reading the mailing list, watching the bug tracker for a while, and still haven't found anything to work on, don't be afraid to ask. Try the IRC channel first—explain that you've been experimenting with the project and are looking for something to do. If the project page specifies a preferred way of communicating with them, try that instead.
You can also email one of the maintainers or developers asking for pointers on how to get involved. Again, explain what you've tried doing, but keep it short and polite. Remember that they do it in their spare time and may be quite busy.
Be wary of sending these beginner questions to project mailing lists or forums. Your email could be reaching thousands of subscribers who may only expect technical discussions to happen there. Make sure general questions are welcome.
Always ask somebody before you embark on adding significant features or carrying out substantial refactoring. Your changes may go against what the authors had planned for and be rejected. Not all maintainers are keen on accepting massive change sets from new contributors. Earn their trust first.
The general rule here is: if you want your code to be included upstream, make it as easy as possible for the maintainer to do that. Don't ignore the patch submission guidelines and follow the preferred code formatting and naming conventions. If there are unit tests, run them and fix all the ones you break. If you're adding new code, add test coverage for it too.
Don't be discouraged if the first code review you receive isn't exactly positive. Take the opportunity to learn from the reviewer's objections, change your code, and submit it again. It doesn't necessarily mean that you were horribly wrong, it’s just that the maintainers have different ways of doing it and are trying to keep the codebase consistent.
If your change ends up being rejected after all, whatever the reason is, don't take it personally and try something else. Consider talking to the maintainers first so you know what they want. If your ideas are that much different, it may be easier to move on to another project. There are so many of them, and you'll most certainly find one that will work for you.
Contributing to open source can be incredibly rewarding. You'll meet lots of like-minded people and make many friends along the way. Your code could be running on millions of computers and making an impact within a couple months of submitting it. It can be lots of hard work, especially when you're just starting out, but it's well worth it. Just pick a project and start being an open source developer!
A collection of articles about how to get started in open source.