You can find a video version of this article on my YouTube channel.
Did you know that you can have a huge impact in contributing to Open Source, even without coding new features or fixing bugs?
Letโs get rid of the misconception of Open Source being only writing code, because there are many other activities that are a lot beneficial, and you should do them regularly!
Hi, Iโm Leonardo and in this article Iโm going to move the spotlight to give some more visibility to those core activities that make Open Source projects successful, without writing a single line of code.
Iโm going to split the activities into 6 categories and provide real examples for each of them:
Documentation
The name is pretty much self-explanatory, but this is really often overlooked. Letโs say you want to contribute to a project, but you have no idea how to run it on your machine. You hope that thereโs a CONTRIBUTING.md file in the repo that tells you how to do that. Without that piece of documentation, you wouldnโt even be able to run the project! Do you get how important documentation is?
If you spot a project with outdated or even missing documentation, for example about setting up the software or describing the architecture, the UIโฆ well, hereโs a huge gap to fill. Writing some docs will give a huge boost to everyone else trying to contribute.
And thereโs even more!
You can for example write blog posts or youtube videos with tutorials, examples, and demos to even further generate content helping the community and the other contributors.
Donโt forget that answering questions on StackOverflow can be considered documentation too! Imagine someone googling for a problem and finding the answer on StackOverflow. You helped not only those who asked the question but everyone else finds your answer later. This counts as well!
Oh, right, you can also translate existing content into your language to spread the knowledge, why not?
Management
Open Source projects have some kind of project management as well, usually on the shoulders of the owners and maintainers, but if youโre an organized person, you can help them a lot!
The main platform, in this case, is the GitHub issues tab. Itโs quite common on large projects that dozen of issues spawn every day and they need some kind of validation and cleanup, that is a highly time-consuming activity.
You can help the community for example by linking duplicate issues, asking for more details in case a bug or a feature request is not clear enough, reproducing bugs and adding yourself more context, and so on.
Awareness
If you have deep knowledge of a particular project and you like public speaking, you might consider organizing workshops, meetups or talks to raise awareness about specific software or project.
Donโt forget that the more visibility a project gets, the more users and contributors might arise.
Do you know an easy way to raise awareness about open source? Hit like on this video and subscribe to my channel. I post regularly videos about Open Source and by helping me, youโre also helping the Open Source community! Thank you!
Design
This can be intended as a visual medium of documentation. Complex structures or flows often require a good visualization to be explained and understood properly. You can consider creating structured UML or simple flow chart diagrams to visualize and simplify.
You can see some examples from the vscode repo, where they show in a simple diagram their core architecture or how they manage the multi-target environment.
Code related
Letโs talk about code that is not features or bugfixes.
Code reviews are always welcome, you can have a look at open pull requests and add comments. Donโt forget to be polite and respectful when reviewing other developersโ code, but constructive feedback is always well perceived, theyโll be grateful.
If you really really want to write code, you can think of creating some internal tools, for example, to quickly set up the project, improve the test coverage, and make debugging and local development easier. In general, code which helps the other contributors to be more productive and safe.
Not only software
If you think that GitHub is only a place where people put code, youโll be surprised!
There are many repositories that focus on collecting information and resources for their communities, not only for developers!
You can find many of them from Explore -> Topics -> Awesome lists.
As you can read, there are lists for a plethora of different topics and thereโs a list of lists serving as an index, organized in categories.
There are repos about books, gaming, business, networkingโฆ all kind of stuff!
Contributing to those lists is still counting as Open Source!
With this last one, we covered all categories. As you can see, there are so many ways to contribute to Open Source, did you know all of them? If you want to add something, just write a comment!
Thanks for reading this post, I hope you find it interesting!
You can also follow me on your favourite platform!
Top comments (7)
Good point about answers to StackOverflow questions as a form of documentation. I actually created my StackOverflow account originally because one day I was looking for something there and stumbled upon a question someone had about a tool I developed. The answer someone posted wasn't wrong, but it was more complicated than it needed to be. So I created an account to post the simpler solution.
And from that day, your answer is there, serving as documentation.
That's great, thanks for sharing!
You're welcome. And thanks for your post. Nice summary of some of the non-code ways of contributing to open source.
Love the fact you pointed out OSS contributing is not simply pushing code, thanks or sharing!
Nice article thanks for sharing
Thank you, glad to hear you liked the article!
I'm doing my best to spread more knowledge about the Open Source world, I hope I'll leave a positive impact with my content :)
Reporting bugs is also a great way to contribute. I was truly amazed when I found Bugzilla for the first time. Most software at the time was proprietary and if you were lucky there was a forum (also a good way to contribute) or (paid) support but that was too high a threshold for me.
Be sure to do due diligence and check for possible duplicates. You don't want to just pile up work for the devs.