5.9 KiB
Contribuer à Roo Code
Nous sommes ravis que vous soyez intéressé à contribuer à Roo Code. Que vous corrigiez un bug, ajoutiez une fonctionnalité ou amélioriez notre documentation, chaque contribution rend Roo Code plus intelligent ! Pour maintenir notre communauté dynamique et accueillante, tous les membres doivent adhérer à notre Code de Conduite.
Rejoindre Notre Communauté
Nous encourageons fortement tous les contributeurs à rejoindre notre communauté Discord ! Faire partie de notre serveur Discord vous aide à :
- Obtenir de l'aide et des conseils en temps réel sur vos contributions
- Vous connecter avec d'autres contributeurs et membres de l'équipe principale
- Rester informé des développements et priorités du projet
- Participer aux discussions qui façonnent l'avenir de Roo Code
- Trouver des opportunités de collaboration avec d'autres développeurs
Signaler des Bugs ou des Problèmes
Les rapports de bugs aident à améliorer Roo Code pour tout le monde ! Avant de créer un nouveau problème, veuillez rechercher parmi les existants pour éviter les doublons. Lorsque vous êtes prêt à signaler un bug, rendez-vous sur notre page d'issues où vous trouverez un modèle pour vous aider à remplir les informations pertinentes.
🔐 Important : Si vous découvrez une vulnérabilité de sécurité, veuillez utiliser l'outil de sécurité Github pour la signaler en privé.
Décider Sur Quoi Travailler
Vous cherchez une bonne première contribution ? Consultez les issues dans la section "Issue [Unassigned]" de notre Projet Github Roo Code Issues. Celles-ci sont spécifiquement sélectionnées pour les nouveaux contributeurs et les domaines où nous aimerions recevoir de l'aide !
Nous accueillons également les contributions à notre documentation ! Qu'il s'agisse de corriger des fautes de frappe, d'améliorer les guides existants ou de créer du nouveau contenu éducatif - nous aimerions construire un référentiel de ressources guidé par la communauté qui aide chacun à tirer le meilleur parti de Roo Code. Vous pouvez cliquer sur "Edit this page" sur n'importe quelle page pour accéder rapidement au bon endroit dans Github pour éditer le fichier, ou vous pouvez plonger directement dans https://github.com/RooVetGit/Roo-Code-Docs.
Si vous prévoyez de travailler sur une fonctionnalité plus importante, veuillez d'abord créer une demande de fonctionnalité afin que nous puissions discuter si elle s'aligne avec la vision de Roo Code.
Configuration de Développement
- Clonez le dépôt :
git clone https://github.com/RooVetGit/Roo-Code.git
- Installez les dépendances :
npm run install:all
- Démarrez la vue web (application Vite/React avec HMR) :
npm run dev
- Débogage :
Appuyez sur
F5(ou Exécuter → Démarrer le débogage) dans VSCode pour ouvrir une nouvelle session avec Roo Code chargé.
Les modifications apportées à la vue web apparaîtront immédiatement. Les modifications apportées à l'extension principale nécessiteront un redémarrage de l'hôte d'extension.
Vous pouvez également créer un fichier .vsix et l'installer directement dans VSCode :
npm run build
Un fichier .vsix apparaîtra dans le répertoire bin/ qui peut être installé avec :
code --install-extension bin/roo-cline-<version>.vsix
Écrire et Soumettre du Code
Tout le monde peut contribuer avec du code à Roo Code, mais nous vous demandons de suivre ces directives pour vous assurer que vos contributions puissent être intégrées en douceur :
-
Gardez les Pull Requests Ciblées
- Limitez les PRs à une seule fonctionnalité ou correction de bug
- Divisez les changements plus importants en PRs plus petites et liées
- Divisez les changements en commits logiques qui peuvent être examinés indépendamment
-
Qualité du Code
- Toutes les PRs doivent passer les vérifications CI qui incluent à la fois le linting et le formatage
- Résolvez toutes les alertes ou erreurs ESLint avant de soumettre
- Répondez à tous les retours d'Ellipsis, notre outil automatisé de revue de code
- Suivez les meilleures pratiques TypeScript et maintenez la sécurité des types
-
Tests
- Ajoutez des tests pour les nouvelles fonctionnalités
- Exécutez
npm testpour vous assurer que tous les tests passent - Mettez à jour les tests existants si vos changements les affectent
- Incluez à la fois des tests unitaires et d'intégration lorsque c'est approprié
-
Directives pour les Commits
- Écrivez des messages de commit clairs et descriptifs
- Référencez les issues pertinentes dans les commits en utilisant #numéro-issue
-
Avant de Soumettre
- Rebasez votre branche sur la dernière main
- Assurez-vous que votre branche se construit avec succès
- Vérifiez à nouveau que tous les tests passent
- Revoyez vos changements pour détecter tout code de débogage ou logs de console
-
Description du Pull Request
- Décrivez clairement ce que font vos changements
- Incluez des étapes pour tester les changements
- Listez tous les changements incompatibles
- Ajoutez des captures d'écran pour les changements d'interface utilisateur
Accord de Contribution
En soumettant une pull request, vous acceptez que vos contributions soient sous licence selon la même licence que le projet (Apache 2.0).