Meewerken aan opensource-projecten: een gids voor beginners

Maarten Draijer
2019-10-21

Opensource-softwareprojecten schieten tegenwoordig als paddenstoelen uit de grond. Het zijn projecten waarbij de documentatie en broncode voor iedereen toegankelijk is. Hierdoor kunnen mensen over de hele wereld meewerken aan het verbeteren van de software. GitLab zelf is een voorbeeld van zo’n opensource-project. Als ontwikkelaar meewerken aan zulke projecten heeft veel voordelen. Het grootste voordeel is dat je er ontzettend veel van leert. Met die kennis los je je eigen software problemen ook veel sneller op.

Maar als je nog nooit hebt meegedaan aan een opensource-project, weet je misschien niet wat er van je verwacht wordt. Daarom vertellen we je in dit artikel wat je precies kunt doen als beginnende bijdrager aan opensource-projecten. Het goede nieuws? Je hoeft er niet eens code voor te kunnen schrijven.

Voorbeelden van opensource-bijdragen

Als je twijfelt of je coding-skills goed genoeg zijn om bij te dragen aan een opensource-project, wees dan gerust: je bent niet de enige. Heel veel nieuwe en zelfs gevorderde programmeurs hebben dat idee, en dat is zonde. Je kunt nooit alles weten. Dat moet je ook helemaal niet willen. Het mooie aan meewerken aan opensource-projecten is juist dat je er veel van leert.

Dus soms moet je het gewoon doen, take the leap. Vaak lijken onbekende dingen van tevoren heel eng, terwijl je achteraf ziet dat het allemaal best meevalt. Grote kans dat het in deze situatie niet anders gaat zijn.

Er zijn allerlei manieren waarop je kunt bijdragen aan een opensource-project. Hieronder zetten we een paar voorbeelden op een rij.

1. Documentatie verbeteren

Een eerste mogelijkheid om deel te nemen aan opensource-projecten is het verbeteren van de documentatie. Dit is voor veel mensen een fijne eerste stap. Liep je bijvoorbeeld tegen bepaalde dingen aan toen je aan het uitzoeken was hoe je een softwaretool moest gebruiken? Als je iets zelf hebt moeten uitzoeken omdat de juiste documentatie ontbrak, kan dat een mooie kans zijn om de documentatie te verbeteren en hiermee de ontwikkelaars én andere gebruikers te helpen.

In veel softwareprojecten wordt de documentatie toegevoegd in dezelfde repository als de code. GitLab bewaart bijvoorbeeld alle documentatie in de ‘doc’ directory van een project. Als je de documentatie niet in de repository kunt vinden, kijk dan of je iets kunt vinden op de doc.- website van het product. GitLab heeft bijvoorbeeld docs.gitlab.com, waarop verwezen wordt naar de documentatie van het product.

2. Meewerken aan issues

Een andere optie is dat je gaat meewerken aan issues. Je zou bijvoorbeeld kunnen beginnen met het opstellen van bug reports voor bepaalde issues die je tegenkomt bij het gebruiken van de software. Voel je je daar een beetje comfortabel bij, dan kun je issues triagen. Met triagen wordt bedoeld dat je een eerste inschatting van de urgentie van de issue maakt.

Triagen doe je als volgt: kies een bestaande issue en probeer deze in je eigen systeem opnieuw te laten verschijnen. Als dat lukt, schrijf dan stap voor stap uit wat er gebeurt en voeg deze omschrijving toe als een comment op de issue. Dit helpt de ontwikkelaar later bij het oplossen van de bug. Als het je niet lukt om de issue te reproduceren, vraag dan de eigenaar van de issue om meer informatie.

3. Bugs oplossen en meewerken aan nieuwe features

Als je kunt programmeren, kun je er ook aan denken om mee te werken aan de reparatie van bugs en het bouwen van nieuwe functionaliteiten. Misschien ben je zelf tegen een bug aangelopen terwijl je de software gebruikte? Werk dan mee aan een fix voor deze bug en ervaar hoe gaaf het is om een oplossing te bouwen voor een probleem waar je zelf tegenaan bent gelopen.

Richtlijnen voor opensource-bijdragen

Veel opensource-projecten hebben hun eigen ‘contribution guidelines’. Als bijdrager wordt van je verwacht dat je je hieraan houdt. Zulke richtlijnen zijn voornamelijk opgesteld om het proces voor iedereen zo gemakkelijk mogelijk te laten verlopen. Op die manier hoeven beheerders bijvoorbeeld niet steeds te vragen om aanpassingen over de manier waarop de code is geschreven. Het volgen van de richtlijnen vergroot de kans dat je bijdragen worden goedgekeurd.

Het is dus belangrijk om voor de tijd goed de contribution guidelines te checken, vooral als je bugs gaat oplossen of mee wilt bouwen aan nieuwe functionaliteiten. De richtlijnen voor bijdragen vind je vaak in de repository van het project: zoek daar naar een CONTRIBUTING.md bestand. Om het het vinden van zo’n gids zo gemakkelijk mogelijk te maken, plaatst GitLab overigens automatisch een link op de homepage van projecten naar ‘Contribution guide’ als er een CONTRIBUTING.md bestand in de repository staat.

Werk mee aan GitLab

GitLab is een voorbeeld van een groot opensource-project waar iedereen van harte welkom is. Wil je eens ervaren hoe dat gaat, bijdragen aan zo’n groot project? Je bent vrij om mee te werken aan GitLab door middel van één van de hierboven genoemde activiteiten.

Veel mensen vinden het meewerken aan opensource-projecten een leuke en leerzame ervaring. Ons advies als het je eerste keer is: begin klein. Je zult zien dat je stapje voor stapje steeds zelfverzekerder wordt en steeds grotere stappen maakt. Veel succes en veel plezier!

Jouw nieuwe GitLab instance is binnen 5 minuten online
Registreer