Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
141 lines (92 loc) · 6.17 KB

CONTRIBUTING.md

File metadata and controls

141 lines (92 loc) · 6.17 KB

Bijdragen aan Roo Code

Roo Code is een door de gemeenschap gedreven project en we waarderen elke bijdrage ten zeerste. Om de samenwerking te stroomlijnen, werken we op basis van een Issue-First-aanpak, wat betekent dat alle Pull Requests (PR's) eerst gekoppeld moeten zijn aan een GitHub Issue. Lees deze handleiding zorgvuldig door.

Inhoudsopgave

Voordat je bijdraagt

1. Gedragscode

Alle bijdragers moeten zich houden aan onze Gedragscode.

2. Projectroadmap

Onze roadmap stuurt de richting van het project. Lijn je bijdragen uit met deze belangrijke doelen:

Betrouwbaarheid voorop

  • Zorg ervoor dat het bewerken van diffs en het uitvoeren van commando's consistent betrouwbaar zijn.
  • Verminder wrijvingspunten die regelmatig gebruik ontmoedigen.
  • Garandeer een soepele werking in alle locales en op alle platforms.
  • Breid robuuste ondersteuning uit voor een breed scala aan AI-providers en -modellen.

Verbeterde gebruikerservaring

  • Stroomlijn de UI/UX voor duidelijkheid en intuïtiviteit.
  • Verbeter continu de workflow om te voldoen aan de hoge verwachtingen die ontwikkelaars hebben van dagelijks gebruikte tools.

Toonaangevend in prestaties van agenten

  • Stel uitgebreide evaluatiebenchmarks (evals) op om de productiviteit in de praktijk te meten.
  • Maak het voor iedereen gemakkelijk om deze evals uit te voeren en te interpreteren.
  • Lever verbeteringen die duidelijke stijgingen in de eval-scores aantonen.

Vermeld de afstemming met deze gebieden in je PR's.

3. Word lid van de Roo Code-community

  • Primair: Word lid van onze Discord en stuur een DM naar Hannes Rudolph (hrudolph).
  • Alternatief: Ervaren bijdragers kunnen rechtstreeks deelnemen via GitHub Projects.

Je bijdrage vinden en plannen

Soorten bijdragen

  • Bugfixes: het aanpakken van codeproblemen.
  • Nieuwe functies: het toevoegen van functionaliteit.
  • Documentatie: het verbeteren van handleidingen en duidelijkheid.

Issue-First-aanpak

Alle bijdragen beginnen met een GitHub Issue met behulp van onze slanke sjablonen.

  • Controleer bestaande issues: Zoek in GitHub Issues.
  • Maak een issue aan met:
    • Verbeteringen: sjabloon "Verbeteringsverzoek" (eenvoudige taal gericht op gebruikersvoordeel).
    • Bugs: sjabloon "Bugrapport" (minimale repro + verwacht vs. feitelijk + versie).
  • Wil je eraan werken? Reageer met "Claiming" op de issue en stuur een DM naar Hannes Rudolph (hrudolph) op Discord om toegewezen te worden. De toewijzing wordt in de thread bevestigd.
  • PR's moeten naar de issue linken. Niet-gekoppelde PR's kunnen worden gesloten.

Beslissen waaraan je wilt werken

Bugs rapporteren

  • Controleer eerst bestaande rapporten.
  • Maak een nieuwe bug aan met het "Bugrapport"-sjabloon met:
    • Duidelijke, genummerde reproductiestappen
    • Verwacht vs. feitelijk resultaat
    • Roo Code-versie (vereist); API-provider/model indien relevant
  • Beveiligingsproblemen: Rapporteer privé via beveiligingsadviezen.

Ontwikkelings- en indieningsproces

Ontwikkelingsopstelling

  1. Fork & Klonen:
git clone https://github.com/JOUW_GEBRUIKERSNAAM/Roo-Code.git
  1. Afhankelijkheden installeren:
pnpm install
  1. Debuggen: Openen met VS Code (F5).

Richtlijnen voor het schrijven van code

  • Eén gerichte PR per functie of fix.
  • Volg de best practices van ESLint en TypeScript.
  • Schrijf duidelijke, beschrijvende commits die verwijzen naar issues (bijv. Fixes #123).
  • Zorg voor grondige tests (npm test).
  • Rebase naar de nieuwste main-tak vóór indiening.

Een Pull Request indienen

  • Begin als een Concept-PR als je vroege feedback wilt.
  • Beschrijf je wijzigingen duidelijk volgens het Pull Request-sjabloon.
  • Koppel de issue in de PR-beschrijving/titel (bijv. "Fixes #123").
  • Zorg voor schermafbeeldingen/video's voor UI-wijzigingen.
  • Geef aan of documentatie-updates nodig zijn.

Pull Request-beleid

  • Moet verwijzen naar een toegewezen GitHub Issue. Om toegewezen te worden: reageer met "Claiming" op de issue en stuur een DM naar Hannes Rudolph (hrudolph) op Discord. De toewijzing wordt in de thread bevestigd.
  • Niet-gekoppelde PR's kunnen worden gesloten.
  • PR's moeten slagen voor CI-tests, in lijn zijn met de roadmap en duidelijke documentatie hebben.

Beoordelingsproces

  • Dagelijkse triage: Snelle controles door onderhouders.
  • Wekelijkse diepgaande beoordeling: Uitgebreide beoordeling.
  • Itereer snel op basis van feedback.

Juridisch

Door bij te dragen, ga je ermee akkoord dat je bijdragen onder de Apache 2.0-licentie worden gelicentieerd, in overeenstemming met de licentieverlening van Roo Code.