Tipps für den Einstieg in die Mitarbeit an Open-Source-Projekten von Ultralytics

Die Grundlage von Open-Source-Software sind Zusammenarbeit, Lernen und Teilen. Open-Source-Projekte bieten Menschen eine großartige Möglichkeit, zusammenzukommen und etwas Größeres zu schaffen, als sie es allein könnten. Bei Ultralytics liegen uns die Prinzipien von Open Source besonders am Herzen, und wir ermutigen dich stets, zu unseren Open-Source-Projekten beizutragen.

Du möchtest gern mitwirken, sei es durch das Schreiben von Dokumentation, das Prüfen von Code oder das Beheben von Problemen, weißt aber nicht, wo du anfangen sollst, oder stößt auf Probleme? Wir helfen dir beim Einstieg. In diesem Artikel geben wir dir einige Tipps, wie du zu den Open-Source-Projekten von Ultralytics beitragen kannst. Legen wir gleich los!

Warum Beiträge zur Ultralytics-Community wichtig sind#

Bevor wir uns ansehen, wie du mitwirken kannst, wollen wir zunächst klären, warum Beiträge so wichtig sind. Wir sind fest davon überzeugt, dass Beiträge aus der Ultralytics-Community wichtig sind. Wenn du dich an unseren Open-Source-Projekten beteiligst, hilfst du uns nicht nur dabei, bessere Software zu entwickeln. Mitwirkende spielen eine entscheidende Rolle dabei, unsere Technologie offen, gemeinschaftlich und in ständiger Weiterentwicklung zu halten. Deine Beiträge sorgen dafür, dass unsere Projekte lebendig, zugänglich und für Nutzer und Entwickler auf der ganzen Welt nützlich bleiben!

Neben der Entwicklung modernster Software bietet dir die Mitarbeit an Ultralytics-Projekten auch eine hervorragende Gelegenheit, dich weiterzuentwickeln. Du kannst deine Programmier-, Problemlösungs- und Teamfähigkeiten ausbauen und dabei mit erfahrenen Entwicklern zusammenarbeiten, die dir Orientierung und bewährte Vorgehensweisen vermitteln. Deine Arbeit kann sich konkret auf Werkzeuge auswirken, die weltweit von Tausenden Menschen genutzt werden. Der Austausch mit unserer Community kann dir außerdem helfen, dein berufliches Netzwerk zu erweitern, neue Möglichkeiten zu erschließen und dein Portfolio auszubauen, damit du bei Arbeitgebern hervorstichst.

Abb. 1. Gründe für eine Mitarbeit. Bild vom Autor.

So kannst du mit Beiträgen zu den Open-Source-Projekten von Ultralytics beginnen#

Ein guter Einstieg ist ein Blick in den offiziellen Leitfaden für Beiträge zu Ultralytics. Er enthält zahlreiche bewährte Vorgehensweisen und Tipps, mit denen du möglichst viel aus deinen Beiträgen machen kannst. Mach dich zunächst mit dem aktuellen Stand des Projekts vertraut, indem du die Richtlinien für Beiträge liest und dich mit dem Code beschäftigst.

Ganz gleich, ob du dich an der Entwicklung beteiligen oder einfach den neuesten Code erkunden möchtest: Als Nächstes solltest du das Ultralytics-Repository klonen. Danach kannst du in das Projektverzeichnis wechseln und das Paket wie im folgenden Codebeispiel gezeigt im bearbeitbaren Modus installieren.

Wenn du Hilfe brauchst, findest du in unserer Kurzanleitung alles, was du für einen reibungslosen Einstieg benötigst.

Möglichkeiten zur Mitarbeit#

Sobald du deine Umgebung eingerichtet hast und mit dem Projekt vertraut bist, kannst du die verschiedenen Bereiche erkunden, in denen du etwas bewirken kannst. Ultralytics bietet dir mehrere Möglichkeiten zur Mitarbeit. Du kannst je nach deinen Fähigkeiten und Interessen entscheiden, wie du dich einbringen möchtest.

Hier sind einige Möglichkeiten:

• Dokumentation: Beiträge zur Dokumentation sind eine gute Möglichkeit, dich mit dem Projekt vertraut zu machen und gleichzeitig deine Schreibfähigkeiten zu verbessern. Du kannst vorhandene Dokumentation überarbeiten, fehlende Informationen ergänzen oder neue Anleitungen erstellen, die anderen die Mitarbeit erleichtern.
• Fehlerbehebungen: Wenn du Programmiererfahrung hast, kannst du Fehler beheben. Das reicht von kleineren Anpassungen bis hin zu komplexeren Problemen und gibt dir die Möglichkeit, einen konkreten Beitrag zum Projekt zu leisten.
• Funktionserweiterungen: Für alle, die tiefer einsteigen möchten, kann die Arbeit an Funktionserweiterungen sowohl anspruchsvoll als auch lohnend sein. Dazu kann gehören, neue Funktionen hinzuzufügen, bestehende zu verbessern oder an der Projekt-Roadmap zu arbeiten.
• Pull-Request-Reviews: Pull Requests zu überprüfen ist eine weitere wertvolle Möglichkeit, einen Beitrag zu leisten – besonders, wenn du mit den Standards und bewährten Verfahren des Projekts vertraut bist. Mit deinem Feedback und Verbesserungsvorschlägen trägst du dazu bei, die Qualität und Integrität der Codebasis zu erhalten.
• Diskussionen in der Community: An Diskussionen in der Community teilzunehmen ist eine hervorragende Möglichkeit, einen Beitrag zu leisten, wenn du gerne zusammenarbeitest und Ideen austauschst. Beteilige dich an laufenden Gesprächen, bring neue Ideen ein oder hilf anderen mit deinen Erkenntnissen und Lösungsvorschlägen.

Jeder dieser Bereiche bietet eine besondere Möglichkeit, einen Beitrag zu leisten. Du kannst den Bereich auswählen, der am besten zu deinen Stärken und Interessen passt. Denk daran: Jeder Beitrag spielt eine wichtige Rolle dabei, Ultralytics weiterzuentwickeln und wachsen zu lassen – ganz gleich, wie klein er ist.

Abb. 2. Jeder Beitrag zählt in unserer wachsenden Community. Bildquelle: Envato Elements.

Beiträge zur Open-Source-Dokumentation von Ultralytics leisten#

Wenn du einen Beitrag zur Dokumentation von Ultralytics leisten möchtest, sieh dir zunächst die vorhandene Dokumentation an und prüfe, ob es Issues oder Diskussionen zu Bereichen gibt, die verbessert werden müssen. So stellst du sicher, dass sich deine Beiträge auf die Bereiche konzentrieren, in denen sie am dringendsten gebraucht werden.

Achte beim Schreiben oder Bearbeiten darauf, die Richtlinien des Projekts einzuhalten, damit die Dokumentation einheitlich bleibt. Hier sind einige Tipps zur Formatierung:

• Verwende immer Markdown-Formatierung.
• Beginne jedes Dokument mit einer klaren Einleitung und verwende eine einfache, verständliche Sprache.
• Verwende Aufzählungspunkte für Listen, aussagekräftige Linktexte und Bilder mit einer Größe von weniger als 1 MB, damit Seiten schnell geladen werden.
• Wenn du Fragen zur Formatierung hast, kannst du ganz einfach überprüfen, wie frühere Dokumentationen formatiert wurden.

Abb. 3. Ein Beispiel für Markdown-Formatierung (links) und die fertig gerenderte Dokumentation (rechts). Bild vom Autor.

Wenn du deinen Entwurf fertiggestellt hast, solltest du ihn in einer lokalen Dokumentationsversion in der Vorschau ansehen. So kannst du Probleme erkennen, bevor du ihn einreichst. Klone dazu zuerst das Repository und wechsle in das Projektverzeichnis:

Als Nächstes kannst du die erforderlichen Abhängigkeiten installieren:

Starte schließlich die Dokumentation lokal, um deine Änderungen zu überprüfen:

Du kannst die lokal erstellte Dokumentation anzeigen, indem du in deinem Webbrowser http://127.0.0.1:8000/ aufrufst.

Nachdem du Verständlichkeit, Richtigkeit und Einheitlichkeit geprüft hast, kannst du einen Pull Request mit einer klaren Beschreibung des erstellten Dokuments einreichen. Achte darauf, das Dokument im passenden Abschnitt abzulegen (Leitfäden, Lösungen, Integrationen usw.). Sieh dir außerdem die Datei index.md für die relevanten Abschnitte und die gesamte Datei mkdocs.yml an und nimm bei Bedarf Änderungen vor. Sorgfalt erleichtert den Review-Prozess und stellt sicher, dass dein Beitrag gut in das Projekt integriert wird.

Wichtige Hinweise zu Beiträgen zu Open-Source-Code#

Wenn du Code zum Ultralytics-Projekt beiträgst, solltest du bewährte Verfahren befolgen, damit dein Code sauber, wartbar und leicht zu integrieren ist. Hier sind einige wichtige Punkte, die du beachten solltest:

• Vermeide Code-Duplikate: Verwende nach Möglichkeit vorhandenen Code wieder und beschränke unnötige Argumente auf ein Minimum.
• Nimm kleinere, gezielte Änderungen vor: Konzentriere dich auf kleinere, klar abgegrenzte Änderungen statt auf umfangreiche Anpassungen.
• Vereinfache oder entferne Code: Suche nach Möglichkeiten, den Code zu vereinfachen oder unnötige Teile zu entfernen.
• Verfasse aussagekräftige Docstrings: Erkläre klar, was dein Code macht, und verlinke auf relevante Ressourcen.
• Vermeide unnötige Abhängigkeiten: Füge Abhängigkeiten nur hinzu, wenn sie unbedingt erforderlich sind.

Abb. 4. Bewährte Verfahren zur Dokumentation des Quellcodes.

Es ist außerdem wichtig, die langfristige Wartbarkeit der Codebasis zu berücksichtigen. Überlege vor jeder Änderung, ob sie vorhandenen Code anderer Personen beeinträchtigen könnte, der Ultralytics verwendet. Falls ja, überlege, wie du das verhindern kannst, und achte darauf, dass deine Änderungen möglichst kompatibel sind.

Sobald du einen Codebeitrag entwickelt hast, musst du ihn testen. Du kannst Frameworks wie pytest verwenden, um deine Änderungen vor dem Einreichen zu testen. Eine einheitliche Codeformatierung ist ein weiterer wichtiger Aspekt deines Beitrags. Tools wie der Ruff Formatter helfen dir, einen einheitlichen Stil beizubehalten und logische Fehler oder Inkonsistenzen in deinem Code zu erkennen.

Pull Requests überprüfen#

Pull Requests (PRs) zu überprüfen ist eine hervorragende Möglichkeit, einen Beitrag zu leisten! Ein PR wird erstellt, wenn jemand darum bittet, die eigenen Änderungen in das Hauptprojekt zu übernehmen. So bleibt das Ultralytics-Projekt in gutem Zustand. Wenn du einen PR überprüfst, solltest du nachvollziehen, warum die Änderungen vorgenommen wurden. Die Autorin oder der Autor sollte den Zweck und die Vorteile der Aktualisierung klar erläutern. Außerdem solltest du im PR Belege für gründliche Tests finden.

Abb. 5. Was ist ein Pull Request?

Sehen wir uns einige wichtige Punkte an, auf die du achten solltest.

• Prüfe die Unit-Tests: Prüfe, ob der PR Tests für neue Funktionen oder Änderungen enthält, um zu bestätigen, dass der Code wie erwartet funktioniert und keine Probleme verursacht.
• Prüfe Aktualisierungen der Dokumentation: Vergewissere dich, dass die Dokumentation an Änderungen oder neue Funktionen angepasst wurde. Dazu gehören Beispiele, API-Referenzen und weitere relevante Details.
• Bewerte die Auswirkungen auf die Leistung: Überlege, wie sich die Änderungen auf die Leistung auswirken. Bitte bei Bedarf um Leistungsbenchmarks oder zusätzliche Tests.
• Prüfe die CI-Tests: Vergewissere dich, dass alle Tests zur kontinuierlichen Integration (CI) bestanden wurden, einschließlich der Prüfungen der Codeformatierung und der Unit-Tests.
• Arbeite gemeinsam an Fehlerbehebungen: Wenn Tests fehlschlagen, arbeite mit der Autorin oder dem Autor zusammen, um die Probleme vor der Freigabe des PRs zu beheben.

Gib als Reviewer konkretes und verständliches Feedback zu Problemen und Bedenken. Schlage Verbesserungen vor und stelle Fragen, die der Autorin oder dem Autor helfen, mögliche Probleme zu durchdenken. Ermutige dazu, bewährte Verfahren beim Programmieren, Testen und Dokumentieren einzuhalten, und verweise bei Bedarf auf hilfreiche Ressourcen. Nicht zuletzt solltest du immer die Mühe anerkennen, die in den PR geflossen ist. Positives Feedback trägt zu einer freundlichen und gemeinschaftlichen Atmosphäre in der Open-Source-Community bei.

Bei Beiträgen geht es vor allem um die Community#

Beiträge zu Open-Source-Projekten wie Ultralytics können dir ein inspirierendes Gemeinschaftsgefühl vermitteln. Ob du Code schreibst, PRs überprüfst, Dokumentation aktualisierst oder dich an Diskussionen beteiligst – jeder Einsatz hilft dem Projekt, sich weiterzuentwickeln und zu wachsen. Issues zu beantworten oder dich an Gesprächen auf GitHub, Discord, Subreddit oder anderen Foren zu beteiligen, ist eine wertvolle Möglichkeit, einen Beitrag zu leisten und mit anderen in Kontakt zu kommen. Denk daran: Jeder deiner Beiträge hat eine wichtige Wirkung und trägt dazu bei, ein gemeinschaftliches und unterstützendes Umfeld für alle Beteiligten zu schaffen – ganz gleich, wie klein er ist!

Bei Ultralytics setzen wir uns leidenschaftlich dafür ein, Innovationen in der Open-Source-Community voranzutreiben. Besuche unser GitHub-Repository, um über unsere neuesten Entwicklungen auf dem Laufenden zu bleiben. Werde Teil unserer lebendigen Community und erfahre, wie wir Branchen wie die Landwirtschaft und das verarbeitende Gewerbe voranbringen.