Tipps für den Start als Mitwirkender an den Open-Source-Projekten von Ultralytics

Die Basis von Open-Source-Software ist Zusammenarbeit, Lernen und Teilen. Open-Source-Projekte sind eine großartige Möglichkeit für Menschen, zusammenzukommen, um etwas zu schaffen, das größer ist als sie selbst. Bei Ultralytics liegen uns die Prinzipien von Open Source sehr am Herzen und wir ermutigen dich immer dazu, an unseren Open-Source-Projekten mitzuarbeiten.

Wenn du dich darauf freust, einen Beitrag zu leisten – sei es durch das Schreiben von Dokumentationen, das Reviewen von Code oder das Lösen von Problemen – dir aber unsicher bist, wo du anfangen sollst, oder auf Probleme stößt, sind wir hier, um dir den Einstieg zu erleichtern. In diesem Artikel führen wir dich durch einige Tipps, wie du anfangen kannst, an Ultralytics Open-Source-Projekten mitzuarbeiten. Legen wir direkt los!

Link to this sectionDie Bedeutung der Beiträge der Ultralytics-Community#

Bevor wir uns ansehen, wie man einen Beitrag leistet, lass uns die Frage beantworten, warum Beiträge so wichtig sind. Wir glauben fest an die Bedeutung von Beiträgen aus der Ultralytics-Community. Indem du an unseren Open-Source-Projekten teilnimmst, tust du mehr, als uns nur dabei zu helfen, bessere Software zu entwickeln. Mitwirkende spielen eine Schlüsselrolle dabei, sicherzustellen, dass unsere Technologie offen, kollaborativ und ständig in Entwicklung bleibt. Deine Beiträge halten unsere Projekte erfolgreich, zugänglich und nützlich für Anwender und Entwickler auf der ganzen Welt!

Neben der Erstellung modernster Software ist die Mitarbeit an Ultralytics-Projekten auch eine fantastische Gelegenheit für dich, zu wachsen. Du kannst deine Fähigkeiten in den Bereichen Programmierung, Problemlösung und Teamarbeit weiterentwickeln, während du mit erfahrenen Entwicklern zusammenarbeitest, die dir Orientierung geben und Best Practices teilen können. Dein Einsatz kann einen echten Einfluss auf Werkzeuge haben, die von tausenden Menschen weltweit genutzt werden. Der Austausch mit unserer Community kann dir auch dabei helfen, dein berufliches Netzwerk zu erweitern, neue Möglichkeiten zu eröffnen und dein Portfolio zu verbessern, um bei Arbeitgebern herauszustechen.

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

Link to this sectionWie du mit Ultralytics Open-Source-Beiträgen beginnst#

Ein guter Ausgangspunkt ist der Blick in den offiziellen Ultralytics-Leitfaden für Mitwirkende. Er ist vollgepackt mit Best Practices und Tipps, die dir helfen, das Beste aus deinen Beiträgen herauszuholen. Der erste Schritt besteht darin, dich mit dem vertraut zu machen, was bereits Teil des Projekts ist, indem du die Richtlinien für Mitwirkende verstehst und in den Code eintauchst.

Egal, ob du an der Entwicklung mitwirken oder einfach nur den neuesten Code erkunden möchtest, der nächste Schritt ist das Klonen des Ultralytics-Repositorys. Sobald du das getan hast, kannst du in das Projektverzeichnis gehen und das Paket im editierbaren Modus installieren, wie im Code-Schnipsel unten gezeigt.

Wenn du Hilfe benötigst, bietet unser Quickstart-Leitfaden alles, was du für einen reibungslosen Start brauchst.

Link to this sectionVerschiedene Bereiche für Beiträge#

Sobald du deine Umgebung eingerichtet hast und dich mit dem Projekt auskennst, kannst du die verschiedenen Bereiche erkunden, in denen du einen bedeutenden Beitrag leisten kannst. Ultralytics bietet verschiedene Möglichkeiten, sich zu beteiligen, und du kannst basierend auf deinen Fähigkeiten und Interessen wählen, wie du mitwirken möchtest.

Hier ist ein Überblick über einige der Optionen:

• Dokumentation: Die Mitarbeit an der Dokumentation ist eine großartige Möglichkeit, tief in das Projekt einzutauchen und gleichzeitig deine Schreibfähigkeiten zu verbessern. Du kannst helfen, indem du bestehende Dokumentationen verbesserst, fehlende Details hinzufügst oder neue Anleitungen erstellst, die es anderen erleichtern, einen Beitrag zu leisten.
• Fehlerbehebungen: Wenn du etwas Programmiererfahrung hast, ziehe in Erwägung, an Fehlerbehebungen zu arbeiten. Diese können von kleineren Anpassungen bis hin zu komplexeren Problemen reichen und geben dir die Chance, einen spürbaren Einfluss auf das Projekt zu nehmen.
• Funktionserweiterungen: Für diejenigen, die bereit sind, tiefer einzutauchen, kann die Arbeit an Funktionserweiterungen sowohl herausfordernd als auch lohnend sein. Dies kann das Hinzufügen neuer Funktionen, das Verbessern bestehender oder die Arbeit an der Projekt-Roadmap umfassen.
• Pull-Request-Reviews: Das Reviewen von Pull Requests ist eine weitere wertvolle Möglichkeit, beizutragen, besonders wenn du mit den Standards und Best Practices des Projekts vertraut bist. Indem du Feedback gibst und Verbesserungen vorschlägst, hilfst du dabei, die Qualität und Integrität der Codebasis zu wahren.
• Community-Diskussionen: Die Teilnahme an Community-Diskussionen ist eine ausgezeichnete Möglichkeit beizutragen, wenn du Freude an Zusammenarbeit und dem Austausch von Ideen hast. Beteilige dich an laufenden Unterhaltungen, schlage neue Ideen vor oder hilf anderen, indem du deine Erkenntnisse und Lösungen anbietest.

Jeder dieser Bereiche bietet eine einzigartige Möglichkeit, einen Beitrag zu leisten, und du kannst denjenigen wählen, der am besten zu deinen Stärken und Interessen passt. Denke daran, dass jeder Beitrag, egal wie klein, eine Schlüsselrolle dabei spielt, Ultralytics wachsen und sich weiterentwickeln zu lassen.

Abb. 2. Jeder Beitrag wird in unserer wachsenden Community geschätzt. Bildquelle: Envato Elements.

Link to this sectionBeitrag zur Ultralytics Open-Source-Dokumentation#

Wenn du zur Ultralytics-Dokumentation beiträgst, achte darauf, die bestehende Dokumentation zu prüfen und nach Themen oder Diskussionen zu suchen, die Bereiche mit Verbesserungsbedarf hervorheben. Dies hilft sicherzustellen, dass sich deine Beiträge auf die Bereiche konzentrieren, in denen sie am dringendsten benötigt werden.

Wenn du schreibst oder bearbeitest, denke daran, dass es entscheidend ist, die Richtlinien des Projekts zu befolgen, um die Konsistenz zu wahren. Hier sind ein paar Formatierungstipps:

• Verwende immer Markdown-Formatierung.
• Beginne jedes Dokument mit einer klaren Einleitung und halte deine Sprache einfach und zugänglich.
• Verwende Aufzählungspunkte für Listen, beschreibende Texte für Links und Bilder unter 1 MB, damit die Seiten schnell laden.
• Falls du Fragen zur Formatierung hast, ist ein einfacher Weg, deine Formatierung zu überprüfen, nachzusehen, wie frühere Dokumentationen formatiert wurden.

Abb. 3. Ein Beispiel für Markdown-Formatierung (links) und das endgültige visualisierte Dokument (rechts). Bild vom Autor.

Sobald du deinen Entwurf erstellt hast, ist es wichtig, ihn durch lokales Erstellen der Dokumentation in der Vorschau zu betrachten. So kannst du eventuelle Probleme vor dem Einreichen finden. Beginne dazu mit dem Klonen des Repositorys und wechsle in das Projektverzeichnis:

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

Schließlich kannst du die Dokumentation lokal bereitstellen, um deine Änderungen zu überprüfen:

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

Nachdem du sie auf Klarheit, Genauigkeit und Konsistenz geprüft hast, kannst du einen Pull Request mit einer klaren Beschreibung des von dir erstellten Dokuments einreichen. Achte darauf, das Dokument im entsprechenden Abschnitt basierend darauf zu platzieren, wo es am besten hingehört und passt (guides, solutions, integrations usw.). Bitte wirf auch einen Blick auf die Datei index.md für die relevanten Abschnitte sowie die allgemeine mkdocs.yml Datei und nimm bei Bedarf Aktualisierungen vor. Aufmerksamkeit für Details hilft dabei, dass der Review-Prozess reibungslos verläuft und stellt sicher, dass dein Beitrag gut in das Projekt integriert wird.

Link to this sectionDinge, die du bei der Mitarbeit am Open-Source-Code beachten solltest#

Wenn du Code-Beiträge zum Ultralytics-Projekt leistest, ist es wichtig, Best Practices zu befolgen, die dazu beitragen, dass dein Code sauber, wartbar und einfach zu integrieren ist. Hier sind einige wichtige Punkte, die du beachten solltest:

• Vermeide Code-Duplizierung: Nutze bestehenden Code wo immer möglich wieder und minimiere unnötige Argumente.
• Mache kleinere, fokussierte Änderungen: Konzentriere dich auf kleinere, gezielte Änderungen statt auf große Modifikationen.
• Vereinfache oder entferne Code: Suche nach Gelegenheiten, den Code zu vereinfachen oder unnötige Teile zu entfernen.
• Schreibe effektive Docstrings: Erkläre klar, was dein Code tut, und verlinke auf relevante Ressourcen.
• Vermeide unnötige Abhängigkeiten: Füge Abhängigkeiten nur hinzu, wenn sie absolut notwendig sind.

Abb. 4. Best Practices für die Quellcode-Dokumentation.

Es ist auch wichtig, die langfristige Wartbarkeit der Codebasis zu berücksichtigen. Bevor du Änderungen vornimmst, frage dich, ob deine Modifikationen den bestehenden Code von jemandem, der Ultralytics nutzt, beschädigen könnten. Wenn ja, überlege, wie du dies angehen kannst, und stelle sicher, dass deine Änderungen so kompatibel wie möglich sind.

Sobald du ein Stück Code entwickelt hast, das du beisteuern möchtest, musst du es testen. Du kannst Frameworks wie pytest verwenden, um deine Änderungen zu testen, bevor du sie einreichst. Konsistente Code-Formatierung ist ein weiterer Aspekt deines Beitrags, der sehr wichtig ist. Tools wie der Ruff Formatter können dir helfen, die stilistische Konsistenz zu wahren und logische Fehler oder Inkonsistenzen in deinem Code zu erkennen.

Link to this sectionReview von Pull Requests#

Das Reviewen von Pull Requests (PRs) ist eine großartige Möglichkeit, einen Beitrag zu leisten! Ein PR wird erstellt, wenn jemand vorschlägt, seine Änderungen in das Hauptprojekt zu mergen. Es hilft, den reibungslosen Betrieb des Ultralytics-Projekts sicherzustellen. Wenn du einen PR reviewst, stelle sicher, dass du verstehst, warum die Änderungen vorgenommen wurden. Der Autor sollte den Zweck und die Vorteile der Aktualisierung klar erklären, und du solltest Nachweise für gründliche Tests in ihrem PR sehen.

Abb. 5. Was ist ein Pull Request?

Gehen wir ein paar wichtige Punkte durch, auf die du dich konzentrieren solltest.

• Auf Unit-Tests prüfen: Überprüfe, ob der PR Tests für neue Funktionen oder Änderungen enthält, um sicherzustellen, dass der Code wie erwartet funktioniert und keine Probleme verursacht.
• Dokumentationsaktualisierungen prüfen: Überprüfe, ob die Dokumentation aktualisiert wurde, um Änderungen oder neue Funktionen widerzuspiegeln, einschließlich Beispielen, API-Referenzen und anderen relevanten Details.
• Leistungsauswirkungen bewerten: Überlege, wie sich die Änderungen auf die Leistung auswirken. Fordere bei Bedarf Leistungsbenchmarks oder zusätzliche Tests an.
• CI-Tests verifizieren: Stelle sicher, dass alle Continuous Integration (CI)-Tests bestehen, einschließlich der Überprüfungen der Code-Formatierung und der Unit-Testergebnisse.
• An Korrekturen mitarbeiten: Falls Tests fehlschlagen, arbeite mit dem Autor zusammen, um Probleme zu lösen, bevor du den PR genehmigst.

Als Reviewer solltest du sicherstellen, dass dein Feedback spezifisch und klar bezüglich etwaiger Probleme oder Bedenken ist. Biete Verbesserungsvorschläge an und stelle Fragen, die dem Autor helfen, potenzielle Probleme zu durchdenken. Ermutige ihn dazu, Best Practices bei der Programmierung, dem Testen und der Dokumentation zu befolgen, und zögere nicht, auf Ressourcen hinzuweisen, die helfen könnten. Zu guter Letzt solltest du immer den Aufwand anerkennen, den der Autor in den PR gesteckt hat. Positives Feedback hilft, eine freundliche und kollaborative Atmosphäre in der Open-Source-Community aufrechtzuerhalten.

Link to this sectionBei der Mitarbeit dreht sich alles um die Community#

Die Mitarbeit an Open-Source-Projekten wie Ultralytics kann dir ein inspirierendes Gefühl von Gemeinschaft vermitteln. Egal, ob du Code schreibst, PRs reviewst, Dokumentationen aktualisierst oder an Diskussionen teilnimmst, jeder Einsatz hilft dem Projekt, zu wachsen und sich weiterzuentwickeln. Die Beantwortung von Issues oder die Teilnahme an Unterhaltungen, sei es auf GitHub, Discord, Subreddit oder in anderen Foren, ist eine wertvolle Möglichkeit, beizutragen und sich mit anderen zu vernetzen. Denke daran, dass deine Beiträge, egal wie klein, eine bedeutende Wirkung haben und dabei helfen, eine kollaborative und unterstützende Umgebung für alle Beteiligten zu schaffen!

Bei Ultralytics setzen wir uns leidenschaftlich dafür ein, Innovationen in der Open-Source-Community voranzutreiben. Bleibe über unsere neuesten Entwicklungen auf dem Laufenden, indem du unser GitHub-Repository besuchst. Werde Teil unserer lebendigen Community und sieh dir an, wie wir in Branchen wie Landwirtschaft und Fertigung etwas bewirken.