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 gerne beitragen möchtest – sei es durch das Verfassen von Dokumentationen, das Überprüfen von Code oder das Lösen von Problemen – dir aber nicht sicher bist, wo du anfangen sollst, oder auf einige issues stößt, sind wir hier, um dir den Einstieg zu erleichtern. In diesem Artikel führen wir dich durch einige Tipps, um zu den Open-Source-Projekten von Ultralytics beizutragen. Fangen wir direkt an!

Die Bedeutung der Beiträge der Ultralytics-Community#

Bevor wir uns ansehen, wie man beitragen kann, wollen wir die Frage beantworten, warum Beiträge so entscheidend 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 sich ständig weiterentwickelnd bleibt. Deine Beiträge sorgen dafür, dass unsere Projekte florieren, accessible und für Nutzer sowie Entwickler auf der ganzen Welt von Nutzen sind!

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.

Wie du mit Ultralytics Open-Source-Beiträgen beginnst#

Ein guter Startpunkt ist ein Blick in den official Ultralytics contributing guide. Er ist voll von 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 contributing guidelines verstehst und in den Code eintauchst.

Egal, ob du zur Entwicklung beitragen oder einfach nur den neuesten Code erkunden möchtest, der nächste Schritt ist das clone the Ultralytics repository. Sobald du das getan hast, kannst du in das Projektverzeichnis wechseln und das Paket im editierbaren Modus installieren, wie im folgenden Code-Snippet gezeigt.

Wenn du Hilfe brauchst, bietet our quickstart guide alles, was du für einen reibungslosen Start benötigst.

Verschiedene 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:

• Documentation: Die Mitarbeit an der Dokumentation ist eine hervorragende Möglichkeit, in das Projekt einzusteigen und gleichzeitig deine Schreibfähigkeiten zu verbessern. Du kannst helfen, indem du bestehende Dokumentationen verbesserst, fehlende Details ergänzt oder neue Anleitungen erstellst, die es anderen erleichtern, beizutragen.
• Bug fixes: Wenn du einige Programmiererfahrung hast, ziehe in Betracht, 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.
• Feature enhancements: 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, die Verbesserung bestehender oder die Arbeit an der Projekt-Roadmap beinhalten.
• Pull request reviews: Das Überprüfen von Pull Requests ist ein weiterer wertvoller Beitrag, insbesondere 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 discussions: Die Teilnahme an Community-Diskussionen ist ein hervorragender Beitrag, wenn du gerne zusammenarbeitest und Ideen austauschst. Nimm an laufenden Gesprächen teil, schlage neue Ideen vor oder unterstütze andere, indem du deine Einblicke 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.

Beitrag 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 formatting.
• 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 erstellten Dokumente anzeigen, indem du in deinem Webbrowser zu http://127.0.0.1:8000/ navigierst.

Nachdem du deine Arbeit auf Klarheit, Genauigkeit und Konsistenz überprüft hast, kannst du einen Pull Request mit einer klaren Beschreibung des von dir erstellten Dokuments einreichen. Achte darauf, das Dokument im entsprechenden Abschnitt zu platzieren, je nachdem, wo es hingehört und am besten passt (guides, solutions, integrations usw.). Bitte wirf auch einen Blick auf die index.md-Datei für die relevanten Abschnitte und die gesamte mkdocs.yml-Datei und nimm bei Bedarf Aktualisierungen vor. Liebe zum Detail sorgt für einen reibungslosen Review-Prozess und stellt sicher, dass dein Beitrag gut in das Projekt integriert wird.

Dinge, 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.
• Write effective docstrings: Erkläre klar und deutlich, 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.

Fig 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 beitragen möchtest, musst du es testen. Du kannst Frameworks wie pytest verwenden, um deine Änderungen vor dem Einreichen zu testen. Eine konsistente Code-Formatierung ist ein weiterer sehr wichtiger Aspekt deines Beitrags. Tools wie der Ruff Formatter können dir helfen, die stilistische Konsistenz zu wahren und logische Fehler oder Inkonsistenzen in deinem Code zu erkennen.

Review 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.

Fig 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.
• Verify CI tests: Stelle sicher, dass alle Continuous Integration (CI)-Tests erfolgreich sind, einschließlich Prüfungen der Code-Formatierung und der Ergebnisse von Unit-Tests.
• 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.

Bei der Mitarbeit dreht sich alles um die Community#

Die Mitarbeit an Open-Source-Projekten wie Ultralytics kann dir ein inspirierendes Gemeinschaftsgefühl vermitteln. Ob du nun Code schreibst, PRs überprüfst, Dokumentationen aktualisierst oder an Diskussionen teilnimmst – jede Anstrengung hilft dem Projekt zu wachsen und sich weiterzuentwickeln. Das Beantworten von Issues oder das Führen von Gesprächen, sei es auf GitHub, Discord, Subreddit oder in anderen Foren, ist ein wertvoller Weg, um beizutragen und sich mit anderen zu vernetzen. Denke daran, dass deine Beiträge, egal wie klein sie sind, eine signifikante Wirkung haben und dazu beitragen, eine kollaborative und unterstützende Umgebung für alle Beteiligten zu fördern!

Bei Ultralytics liegt es uns am Herzen, Innovationen in der Open-Source-Community voranzutreiben. Bleibe über unsere neuesten Entwicklungen auf dem Laufenden, indem du unser GitHub repository besuchst. Tritt our vibrant community bei und sieh dir an, wie wir in Branchen wie agriculture und manufacturing etwas bewegen.