Contribuer à Zoo Code

Zoo Code est un projet communautaire, et nous apprécions profondément chaque contribution. Pour simplifier la collaboration, nous fonctionnons sur une base d’abord l’issue, ce qui signifie que toutes les Pull Requests (PRs) doivent d’abord être liées à une Issue GitHub. Veuillez lire attentivement ce guide.

Table des matières

• Avant de contribuer
• Trouver et planifier votre contribution
• Processus de développement et de soumission
• Attentes relatives aux Pull Requests
• Contributions assistées par IA
• Légal

Avant de contribuer

1. Code de conduite

Tous les contributeurs doivent adhérer à notre Code de conduite.

2. Feuille de route du projet

Notre feuille de route guide la direction du projet. Alignez vos contributions sur ces objectifs clés :

La fiabilité d'abord

• Assurez-vous que l'édition de diff et l'exécution de commandes sont fiables de manière constante.
• Réduisez les points de friction qui découragent une utilisation régulière.
• Garantissez un fonctionnement fluide dans toutes les langues et sur toutes les plateformes.
• Étendez le support robuste à une grande variété de fournisseurs et de modèles d'IA.

Expérience utilisateur améliorée

• Simplifiez l'UI/UX pour plus de clarté et d'intuitivité.
• Améliorez continuellement le flux de travail pour répondre aux attentes élevées des développeurs pour les outils à usage quotidien.

Leader en performance d'agent

• Établissez des benchmarks d'évaluation complets (evals) pour mesurer la productivité en conditions réelles.
• Facilitez l'exécution et l'interprétation de ces évaluations par tout le monde.
• Livrez des améliorations qui démontrent des augmentations claires des scores d'évaluation.

Mentionnez l'alignement avec ces domaines dans vos PRs.

3. Rejoins la communauté Zoo Code

• Discord : Rejoins notre Discord.
• Reddit : Rejoins notre Reddit.

Trouver et planifier votre contribution

Types de contributions

• Corrections de bugs : Résoudre les problèmes de code.
• Nouvelles fonctionnalités : Ajouter des fonctionnalités.
• Documentation : Améliorer les guides et la clarté.

Approche Issue-First

Toutes les contributions commencent par une Issue GitHub en utilisant nos modèles simples.

• Vérifiez les issues existantes : Recherchez dans les Issues GitHub.
• Créez une issue en utilisant :
  • Améliorations : Modèle "Demande d'amélioration" (langage simple axé sur l'avantage pour l'utilisateur).
  • Bugs : Modèle "Rapport de bug" (reproduction minimale + attendu vs réel + version).
• Vous voulez y travailler ? Commentez "Je prends en charge" sur l’issue et envoyez un DM à l'équipe principale sur Discord pour être assigné. L’assignation sera confirmée dans le fil de discussion.
• Les PRs doivent être liées à l'issue. Les PRs non liées peuvent être fermées.

Décider sur quoi travailler

• Consulte la page GitHub Issues pour voir les issues.
• Pour la documentation, visitez Zoo Code Docs.

Signaler des bugs

• Vérifiez d'abord les rapports existants.
• Créez un nouveau bug en utilisant le modèle "Rapport de bug" avec :
  • Des étapes de reproduction claires et numérotées
  • Résultat attendu vs réel
  • Version de Zoo Code (requise) ; fournisseur/modèle d'API si pertinent
• Problèmes de sécurité : Signalez-les en privé via les avis de sécurité.

Processus de développement et de soumission

Configuration du développement

1. Fork & Cloner :

git clone https://github.com/YOUR_USERNAME/Zoo-Code.git

2. Installer les dépendances :

pnpm install

3. Débogage : Ouvrir avec VS Code (F5).

Lignes directrices pour l'écriture de code

• Une PR ciblée par fonctionnalité ou correction.
• Suivez les meilleures pratiques d'ESLint et de TypeScript.
• Rédigez des commits clairs et descriptifs faisant référence aux issues (par exemple, Fixes #123).
• Fournissez des tests approfondis (npm test).
• Rebasez sur la dernière branche main avant la soumission.

Soumettre une Pull Request

• Commencez par une PR en brouillon si vous recherchez des commentaires précoces.
• Décrivez clairement vos changements en suivant le modèle de Pull Request.
• Liez l'issue dans la description/le titre de la PR (par exemple, "Fixes #123").
• Fournissez des captures d'écran/vidéos pour les changements d'interface utilisateur.
• Indiquez si des mises à jour de la documentation sont nécessaires.

Politique de Pull Request

• Doit faire référence à une Issue GitHub assignée. Pour être assigné : commentez "Je prends en charge" sur l'issue et envoyez un DM à l'équipe principale sur Discord. L'assignation sera confirmée dans le fil de discussion.
• Les PRs non liées peuvent être fermées.
• Les PRs doivent passer les tests d'intégration continue, s'aligner sur la feuille de route et avoir une documentation claire.

Processus de révision

• Triage quotidien : Vérifications rapides par les mainteneurs.
• Révision hebdomadaire approfondie : Évaluation complète.
• Itérez rapidement en fonction des commentaires.

Attentes relatives aux Pull Requests

Les Pull Requests doivent être révisables, testées et maintenables. Avant d'ouvrir une PR, assurez-vous que :

• Le changement est limité à un problème, un bug ou une amélioration spécifique.
• Vous pouvez expliquer ce que fait le changement et pourquoi il est correct.
• Vous avez testé le changement localement dans la mesure du possible.
• Vous êtes prêt à répondre aux retours de la révision et à effectuer des modifications de suivi raisonnables.
• La PR ne nécessite pas que les mainteneurs réécrivent, reconçoivent ou prennent en charge de manière substantielle l'implémentation avant de pouvoir la fusionner.

Les mainteneurs peuvent fermer les PRs qui sont incomplètes, trop larges, inactives, non alignées avec la direction du projet ou qui créent une charge de révision ou de maintenance disproportionnée. Fermer une PR n'est pas un jugement sur le contributeur ; c'est une décision des mainteneurs que le changement ne peut pas être accepté dans sa forme actuelle.

Contributions assistées par IA

L'utilisation d'outils d'IA est autorisée, mais les contributeurs restent entièrement responsables de leurs soumissions.

Si vous utilisez des outils d'IA pour aider à créer une PR, vous devez :

• Réviser et comprendre chaque modification significative.
• Être capable d'expliquer l'implémentation et les compromis avec vos propres mots.
• Tester vous-même le changement. Si les tests ne sont pas pratiques dans votre environnement, expliquez pourquoi dans la description de la PR et décrivez comment les réviseurs peuvent vérifier le changement.
• Vérifier que le code généré est correct, nécessaire et compatible avec la licence du projet.
• Envisagez de divulguer l'assistance de l'IA dans la description de la PR lorsqu'elle a substantiellement façonné le code, les tests ou la conception — cela aide les réviseurs à donner de meilleurs retours.

Veuillez ne pas soumettre de modifications générées par IA que vous ne comprenez pas ou que vous ne pouvez pas maintenir lors de la révision. Les mainteneurs peuvent fermer les PRs qui semblent substantiellement assistées par IA mais qui manquent de vérification humaine, de justification claire ou de suivi de la révision.

Légal

En contribuant, vous acceptez que vos contributions soient sous licence Apache 2.0, conformément à la licence de Zoo Code.