Open Source – so wirst du zum Contributor

31.12.2023

Suchst du noch einen guten Vorsatz für das neue Jahr? Beteilige dich doch an einem Open Source Projekt und werde Contributor! Hier erfährst du, wie das geht.

Die Teilnahme an Open Source Projekten bietet eine Vielzahl von Vorteilen, sowohl persönlich als auch für die gesamte Software-Community. Brauchst du noch ein paar Gründe, warum sich das lohnt? Na dann:

  1. Lernen und Weiterentwicklung
    Open Source Projekte bieten eine hervorragende Lernumgebung. Durch die Zusammenarbeit mit erfahrenen Entwickler:innen können Teilnehmer ihre Fähigkeiten verbessern und neue Technologien sowie Best Practices erlernen. Dies kann insbesondere für Studierende und Juniors wertvoll sein, da sie Einblicke in professionelle Entwicklungspraktiken erhalten.
  1. Sichtbarkeit und Reputation
    Aktive Beteiligung an Open Source Projekten ermöglicht es Devs, ihre Arbeit öffentlich zu präsentieren. Dies trägt zur Schaffung einer positiven Online-Reputation bei und kann helfen, von potenziellen Arbeitgeber:innen wahrgenommen zu werden.
  1. Freie Software für alle
    Open Source Projekte fördern die Idee freier Software, die von jedem genutzt, studiert, geändert und weitergegeben werden kann. Die gemeinsame Entwicklung trägt zur Schaffung besserer und sicherer Softwarelösungen bei, von denen die gesamte Gesellschaft profitiert.

 

Klingt ja super – aber wie mache ich denn nun mit?

Zuerst musst du dir ein Projekt suchen, an dem du dich beteiligen möchtest. Das kann ein Tool sein, das du selbst schon gerne einsetzt und dem du noch ein neues Feature hinzufügen möchtest. Oder vielleicht hast du eine Softwarebibliothek im Projekt, die mal etwas Liebe vertragen könnte? Manche Projekte markieren auch explizit bekannte Issues, die für Neueinsteiger gut geeignet sind.

 

Forken

Nun geht es an das Forken des Repositorys. Hierbei erstellt man eine eigene Kopie des Projekts, in der Änderungen vorgenommen werden können. Dies geschieht einfach über die Schaltfläche „Fork“ auf der GitHub-Oberfläche. Anschließend kannst du das eigene Repository lokal klonen und Änderungen vornehmen.

Fork-Button bei GitHub
Abbildung 1: der Fork-Button bei GitHub

 

Kontakt suchen

Damit deine Änderung eine Chance hat, angenommen zu werden, solltest du mit den Maintainern des Projekts in Kontakt treten. Außerdem ist es ratsam, sich mit den Projekt-Richtlinien vertraut zu machen. Diese stehen meist in der CONTRIBUTING.md. Solltest du dir trotzdem noch nicht sicher sein, wie du die Anpassung am besten umsetzt, dann bieten die Issues oder Discussions eine gute Plattform, um Ideen auszutauschen. Dabei gilt natürlich immer: freundlich und respektvoll sein! Beim Einreichen von Änderungsvorschlägen ist dann eine klare und präzise Beschreibung des Problems und der vorgeschlagenen Lösung wichtig. Vielleicht arbeitet auch bereits jemand an dem Thema – da hilft ein Austausch dann, doppelte Arbeit zu vermeiden.

Achte bei deinen Änderungen auf eine möglichst hohe Codequalität und orientiere dich an der vorhandenen Architektur. Auch die zugehörigen Tests müssen gepflegt bzw. erweitert werden. Wenn das Projekt einen einheitlichen Codeformatter benutzt, solltest auch du ihn einsetzen. Eine hochwertige Dokumentation deiner Anpassung hilft anderen Leuten in Zukunft dabei, die Software besser zu verstehen.

Tipp: vergiss nicht, deine Git-Autor Einstellungen anzupassen. Was du dort hinterlegst, wird in dem Projekt verewigt. Möchtest du deine eigene E-Mail-Adresse nicht im Commit haben, kannst du auch z. B. eine von GitHub generierte nehmen.

 

Alles vorbereitet – und nun?

Um deine Änderungen ins Hauptprojekt zu bringen, erstellst du nun einen sogenannten „Pull Request“ (PR). Hierbei werden die vorgenommenen Änderungen im eigenen Fork mit dem Originalprojekt abgeglichen. In der Beschreibung des PRs sollten die gemachten Änderungen und der Grund dafür detailliert erläutert werden. Das erleichtert den Maintainern die Prüfung der Änderungen. Gegebenenfalls auftauchende Fragen solltest du zügig beantworten.

Nimm Feedback zu deinem Code dabei nie persönlich! Schließlich zieht ihr alle an einem Strang und wollt die Software verbessern. Gemeinsam schafft ihr es dann sicher zu einem guten Ergebnis.

Falls es automatische Build-Checks gibt, achte darauf, dass sie erfolgreich sind. Sie geben dir schnell Hinweise darauf, ob deine Änderung funktioniert und den Anforderungen des Projekts entspricht.

Beispiel für GitHub PR Checks beim Open Source Projekt Quarkus
Abbildung 2: Beispiel für GitHub PR Checks bei Quarkus (https://github.com/quarkusio/quarkus)

Sobald der Reviewprozess abgeschlossen ist, wird dein PR durch die Maintainer genehmigt. Nun kannst du ihn mergen und dein Code wird Teil von etwas Größerem.

 

Bleib dran!

Wenn dir ein Projekt am Herzen liegt, zeige langfristiges Engagement. Das schafft Vertrauen und kann zu einer engeren Zusammenarbeit führen. Außerdem baust du so Wissen im Projekt auf und kannst auch anderen Contributoren weiterhelfen, wenn sie Fragen haben. Wer weiß – vielleicht bist du ja eines Tages das Gesicht des Projekts?

Zurück zur Übersicht

Kommentar verfassen

Deine E-Mail-Adresse wird nicht veröffentlicht. Erforderliche Felder sind mit * markiert

*Pflichtfelder

*