5.7 KiB
Beitrag zu Roo Code
Wir freuen uns, dass Sie Interesse haben, zu Roo Code beizutragen. Ob Sie einen Fehler beheben, eine Funktion hinzufügen oder unsere Dokumentation verbessern, jeder Beitrag macht Roo Code intelligenter! Um unsere Community lebendig und einladend zu halten, müssen sich alle Mitglieder an unseren Verhaltenskodex halten.
Treten Sie unserer Community bei
Wir ermutigen alle Mitwirkenden nachdrücklich, unserer Discord-Community beizutreten! Teil unseres Discord-Servers zu sein, hilft Ihnen:
- Echtzeit-Hilfe und Anleitung für Ihre Beiträge zu erhalten
- Mit anderen Mitwirkenden und Kernteammitgliedern in Kontakt zu treten
- Über Projektentwicklungen und Prioritäten auf dem Laufenden zu bleiben
- An Diskussionen teilzunehmen, die die Zukunft von Roo Code gestalten
- Kooperationsmöglichkeiten mit anderen Entwicklern zu finden
Fehler oder Probleme melden
Fehlerberichte helfen, Roo Code für alle besser zu machen! Bevor Sie ein neues Issue erstellen, bitte suchen Sie in bestehenden Issues, um Duplikate zu vermeiden. Wenn Sie bereit sind, einen Fehler zu melden, gehen Sie zu unserer Issues-Seite, wo Sie eine Vorlage finden, die Ihnen beim Ausfüllen der relevanten Informationen hilft.
🔐 Wichtig: Wenn Sie eine Sicherheitslücke entdecken, nutzen Sie bitte das Github-Sicherheitstool, um sie privat zu melden.
Entscheiden, woran Sie arbeiten möchten
Suchen Sie nach einem guten ersten Beitrag? Schauen Sie sich Issues im Abschnitt "Issue [Unassigned]" unseres Roo Code Issues Github-Projekts an. Diese sind speziell für neue Mitwirkende und Bereiche ausgewählt, in denen wir Hilfe gebrauchen könnten!
Wir begrüßen auch Beiträge zu unserer Dokumentation! Ob Sie Tippfehler korrigieren, bestehende Anleitungen verbessern oder neue Bildungsinhalte erstellen - wir würden gerne ein Community-geführtes Repository von Ressourcen aufbauen, das jedem hilft, das Beste aus Roo Code herauszuholen. Sie können auf jeder Seite auf "Edit this page" klicken, um schnell zur richtigen Stelle in Github zu gelangen, um die Datei zu bearbeiten, oder Sie können direkt zu https://github.com/RooVetGit/Roo-Code-Docs gehen.
Wenn Sie an einer größeren Funktion arbeiten möchten, erstellen Sie bitte zuerst eine Funktionsanfrage, damit wir diskutieren können, ob sie mit der Vision von Roo Code übereinstimmt.
Entwicklungs-Setup
- Klonen Sie das Repository:
git clone https://github.com/RooVetGit/Roo-Code.git
- Installieren Sie Abhängigkeiten:
npm run install:all
- Starten Sie die Webansicht (Vite/React-App mit HMR):
npm run dev
- Debugging:
Drücken Sie
F5(oder Ausführen → Debugging starten) in VSCode, um eine neue Sitzung mit geladenem Roo Code zu öffnen.
Änderungen an der Webansicht erscheinen sofort. Änderungen an der Kern-Erweiterung erfordern einen Neustart des Erweiterungs-Hosts.
Alternativ können Sie eine .vsix-Datei erstellen und direkt in VSCode installieren:
npm run build
Eine .vsix-Datei erscheint im bin/-Verzeichnis, die mit folgendem Befehl installiert werden kann:
code --install-extension bin/roo-cline-<version>.vsix
Code schreiben und einreichen
Jeder kann Code zu Roo Code beitragen, aber wir bitten Sie, diese Richtlinien zu befolgen, um sicherzustellen, dass Ihre Beiträge reibungslos integriert werden können:
-
Halten Sie Pull Requests fokussiert
- Beschränken Sie PRs auf eine einzelne Funktion oder Fehlerbehebung
- Teilen Sie größere Änderungen in kleinere, zusammenhängende PRs auf
- Unterteilen Sie Änderungen in logische Commits, die unabhängig überprüft werden können
-
Codequalität
- Alle PRs müssen CI-Prüfungen bestehen, die sowohl Linting als auch Formatierung umfassen
- Beheben Sie alle ESLint-Warnungen oder -Fehler vor dem Einreichen
- Reagieren Sie auf alle Rückmeldungen von Ellipsis, unserem automatisierten Code-Review-Tool
- Folgen Sie TypeScript-Best-Practices und halten Sie die Typsicherheit aufrecht
-
Testen
- Fügen Sie Tests für neue Funktionen hinzu
- Führen Sie
npm testaus, um sicherzustellen, dass alle Tests bestanden werden - Aktualisieren Sie bestehende Tests, wenn Ihre Änderungen diese beeinflussen
- Schließen Sie sowohl Unit-Tests als auch Integrationstests ein, wo angemessen
-
Commit-Richtlinien
- Schreiben Sie klare, beschreibende Commit-Nachrichten
- Verweisen Sie auf relevante Issues in Commits mit #issue-nummer
-
Vor dem Einreichen
- Rebasen Sie Ihren Branch auf den neuesten main-Branch
- Stellen Sie sicher, dass Ihr Branch erfolgreich baut
- Überprüfen Sie erneut, dass alle Tests bestanden werden
- Prüfen Sie Ihre Änderungen auf Debug-Code oder Konsolenausgaben
-
Pull Request Beschreibung
- Beschreiben Sie klar, was Ihre Änderungen bewirken
- Fügen Sie Schritte zum Testen der Änderungen hinzu
- Listen Sie alle Breaking Changes auf
- Fügen Sie Screenshots für UI-Änderungen hinzu
Beitragsvereinbarung
Durch das Einreichen eines Pull Requests stimmen Sie zu, dass Ihre Beiträge unter derselben Lizenz wie das Projekt (Apache 2.0) lizenziert werden.