Documentation

Exécuter votre première tâche

Décrivez une tâche, approuvez le plan, puis observez Coroid la construire et la vérifier.

Une tâche est une unité de travail qui aboutit à un seul pull request. Démarrez-en une depuis Nouveau travail.

Choisir une bonne première tâche

La meilleure première tâche est petite, réelle et proche des tests existants. Quelque chose comme « ajouter un --json drapeau à la commande d'exportation, en respectant la structure de sortie que la commande d'importation accepte déjà » donne à Coroid un objectif clair et vous permet d'évaluer facilement le résultat.

À éviter pour une première utilisation :

  • tout ce qui concerne l'authentification, les paiements ou la migration de données
  • un travail nécessitant une décision de conception que vous n'avez pas encore prise
  • les nettoyages vagues — « améliorer la gestion des erreurs » n'a pas de fin précise

Décrivez ce que vous souhaitez

Rédigez le résultat attendu, pas l'implémentation. Indiquez ce qui doit être vrai une fois le travail terminé, et mentionnez tout élément non évident : les fichiers concernés, les conventions à suivre, les éléments à ne pas modifier.

Vous n'avez pas besoin d'écrire le plan. C'est la première chose que produit Coroid, et vous pouvez l'approuver.

S'il existe un contexte que le code ne contient pas — un ADR, un guide de style, un ticket — attachez-le. Consultez Contexte du projet pour découvrir ce que Coroid connaît déjà sans qu'on le lui indique.

Examiner les spécifications

Coroid transforme votre description en spécification: ce qui sera construit, ce qui est hors périmètre, ainsi que les critères d'acceptation qui déterminent le succès. Elle apparaît sur l'onglet Spécifications de la tâche.

Lisez-la avant toute construction. Si les critères d'acceptation ne correspondent pas à vos attentes, corrigez-les dès maintenant — ce sont eux que la phase de vérification testera plus tard. Consultez Spécifications.

Approuver le plan

Pour tout changement au-delà d'une modification mineure, la spécification devient un plan: un ensemble ordonné d'étapes. Vous l'approvez avant que le code ne soit écrit.

C'est le moment le moins coûteux pour intervenir. Rejeter un plan ne vous coûte qu'une minute. Rejeter un pull request déjà terminé entraîne l'échec de toute l'exécution.

Observer son exécution

Une fois approuvée, la tâche entre en PENDING jusqu'à ce qu'une place d'agent se libère, puis IN_PROGRESS. Vous pouvez suivre l'exécution en temps réel : les étapes effectuées, les outils utilisés, les fichiers modifiés, et les résultats des tests au fur et à mesure de leur accumulation.

Vous n'êtes pas obligé d'observer. Les Notifications vous informeront lorsqu'une intervention sera nécessaire ou quand l'exécution sera terminée.

Ce à quoi vous pouvez vous attendre

  • La durée dépend de la taille du changement et du temps nécessaire à votre suite de tests, et non du nombre de places d'agents dont vous disposez. Les places d'agents déterminent le nombre de tâches exécutées simultanément.
  • NEEDS_HUMAN_REVIEW n'est pas une erreur. Cela signifie que Coroid a rencontré une décision que seul vous pouvez prendre. Répondez-y et la tâche poursuivra son cours.
  • Le retravail est normal. Si le réviseur trouve quelque chose à améliorer, cela revient au développeur avant même que vous ne le voyiez.

Suivant

Examiner et fusionner le résultat — ce qui arrive et ce à quoi il faut prêter attention.