Skip to content

Latest commit

 

History

History
138 lines (88 loc) · 5.6 KB

CONTRIBUTING.md

File metadata and controls

138 lines (88 loc) · 5.6 KB

Beitrag zu Roo Code

Roo Code ist ein Community-getriebenes Projekt, und wir schätzen jeden Beitrag sehr. Für eine reibungslose Zusammenarbeit arbeiten wir nach dem Issue-First-Ansatz, was bedeutet, dass alle Pull Requests (PRs) zuerst mit einem GitHub Issue verknüpft werden müssen. Bitte lies diesen Leitfaden sorgfältig durch.

Inhaltsverzeichnis

Bevor du beiträgst

1. Verhaltenskodex

Alle Mitwirkenden müssen sich an unseren Verhaltenskodex halten.

2. Projekt-Roadmap

Unsere Roadmap gibt die Richtung des Projekts vor. Richte deine Beiträge an diesen Schlüsselzielen aus:

Zuverlässigkeit an erster Stelle

  • Sicherstellen, dass Diff-Bearbeitung und Befehlsausführung durchgängig zuverlässig sind.
  • Reibungspunkte reduzieren, die von der regelmäßigen Nutzung abhalten.
  • Reibungslosen Betrieb in allen Sprachen und auf allen Plattformen garantieren.
  • Robuste Unterstützung für eine Vielzahl von KI-Anbietern und -Modellen ausbauen.

Verbesserte Benutzererfahrung

  • Die Benutzeroberfläche für mehr Klarheit und Intuitivität optimieren.
  • Den Workflow kontinuierlich verbessern, um den hohen Erwartungen gerecht zu werden, die Entwickler an täglich genutzte Tools stellen.

Führend bei der Agentenleistung

  • Umfassende Evaluierungsmaßstäbe (Evals) etablieren, um die Produktivität in der realen Welt zu messen.
  • Es für jeden einfach machen, diese Evals durchzuführen und zu interpretieren.
  • Verbesserungen liefern, die klare Steigerungen der Eval-Ergebnisse zeigen.

Erwähne die Ausrichtung an diesen Bereichen in deinen PRs.

3. Werde Teil der Roo Code Community

  • Hauptweg: Tritt unserem Discord bei und schreibe eine DM an Hannes Rudolph (hrudolph).
  • Alternative: Erfahrene Mitwirkende können sich direkt über GitHub Projects beteiligen.

Beitrag finden & planen

Beitragsarten

  • Bugfixes: Fehler im Code beheben.
  • Neue Features: Neue Funktionen hinzufügen.
  • Dokumentation: Anleitungen verbessern und klarer gestalten.

Issue-First-Ansatz

Alle Beiträge müssen mit einem GitHub Issue beginnen.

  • Bestehende Issues prüfen: Durchsuche die GitHub Issues.
  • Issue erstellen: Nutze die passenden Vorlagen:
    • Bugs: "Bug Report"-Vorlage.
    • Features: "Detailed Feature Proposal"-Vorlage. Vor dem Start ist eine Genehmigung erforderlich.
  • Issues beanspruchen: Kommentiere und warte auf die offizielle Zuweisung.

PRs ohne genehmigte Issues können geschlossen werden.

Was soll ich machen?

Bugs melden

Entwicklung & Einreichung

Entwicklungs-Setup

  1. Fork & Clone:
git clone https://github.com/DEIN_USERNAME/Roo-Code.git
  1. Abhängigkeiten installieren:
npm run install:all
  1. Debugging: Öffne mit VS Code (F5).

Code-Richtlinien

  • Ein fokussierter PR pro Feature oder Fix.
  • Folge den ESLint und TypeScript Best Practices.
  • Schreibe klare, beschreibende Commits, die auf Issues verweisen (z.B. Fixes #123).
  • Liefere gründliche Tests (npm test).
  • Rebase auf den neuesten main-Branch vor dem Einreichen.

Einen Pull Request einreichen

  • Beginne als Draft PR, wenn du frühes Feedback suchst.
  • Beschreibe deine Änderungen klar und folge der Pull Request Vorlage.
  • Stelle Screenshots/Videos für UI-Änderungen bereit.
  • Gib an, ob Dokumentationsaktualisierungen notwendig sind.

Pull Request Richtlinie

  • Muss auf vorab genehmigte, zugewiesene Issues verweisen.
  • PRs ohne Einhaltung der Richtlinie können geschlossen werden.
  • PRs sollten CI-Tests bestehen, zur Roadmap passen und klare Dokumentation haben.

Review-Prozess

  • Tägliche Triage: Schnelle Prüfungen durch Maintainer.
  • Wöchentliche Tiefenprüfung: Umfassende Bewertung.
  • Zeitnah auf Feedback reagieren und entsprechend iterieren.

Rechtliches

Mit deinem Beitrag erklärst du dich damit einverstanden, dass deine Beiträge unter der Apache 2.0 Lizenz lizenziert werden, konsistent mit der Lizenzierung von Roo Code.