Parcours 02Leçon 2 / 6

Donnez à l’agent un contexte de dépôt utile

Fournissez des instructions actuelles, le code pertinent et des commandes de vérification opérationnelles, sans exposer d’informations inutiles.

Pratique9 minRevu

Publié par Notre méthode de rédaction

Ce que vous apprendrez

  • Préparer un contexte ciblé pour une tâche dans le dépôt.
  • Repérer les instructions obsolètes ou contradictoires.
  • Exclure du contexte les identifiants secrets et les données privées sans rapport avec la tâche.

Partez de la copie de travail actuelle

Un agent doit savoir quel dépôt et quelle branche il modifie. Il doit aussi savoir si le répertoire de travail contient des changements sans rapport avec sa tâche. Ces faits déterminent ce qu’il peut modifier sans risque et comment interpréter le diff final.

Demandez à l’agent d’inspecter les instructions du projet et la configuration des packages avant l’implémentation. Une commande mémorisée dans un autre dépôt peut être incorrecte ici. Connaître le nom du framework ne suffit pas pour connaître sa version installée ou les conventions du projet.

Pour une petite modification, fournissez le module concerné, ses appelants, les tests et la décision d’architecture. Ajoutez des informations lorsque l’investigation révèle un besoin précis.

Utilisez les instructions du dépôt pour les règles stables

Un fichier d’instructions peut décrire les commandes prises en charge, les limites des modules, les exigences de revue et les actions qui demandent une décision d’un responsable. La convention AGENTS.md donne aux outils de programmation un emplacement reconnaissable pour ces informations. Leur prise en charge et l’ordre de priorité des instructions peuvent varier : vérifiez le comportement de votre outil.

Conservez les règles stables du projet dans le dépôt. Gardez la tâche actuelle dans son brief. Ne transformez pas le fichier d’instructions en historique de toutes les conversations ni en liste de plans temporaires.

Une instruction utile dit : « Exécutez les tests d’intégration d’autorisation lorsqu’une route modifie le comportement d’accès. » Une instruction vague dit : « Faites toujours attention à la sécurité. » La première indique un déclencheur et une action vérifiable lors de la revue.

Comparez les instructions au code

Les instructions deviennent obsolètes lorsque les commandes, les répertoires ou l’architecture changent. Si un guide mentionne un script absent, inspectez la configuration des packages. Si un document décrit un service en lecture seule, inspectez les permissions avant de vous fier à cette affirmation.

Consignez le conflit. Utilisez des preuves directes sur la version actuelle pour comprendre le comportement de l’implémentation. N’abandonnez pas discrètement une politique volontaire parce qu’un ancien code la viole. La politique et le comportement actuel répondent à des questions différentes.

Par exemple, le guide peut interdire l’écriture directe dans une branche partagée alors qu’un ancien script la pratique encore. Il faut conserver la politique et corriger le script. Le code existant n’autorise pas à répéter une action interdite.

Gardez un contexte pertinent et sûr

Un dépôt complet peut contenir des identifiants secrets, des fixtures privées, des exports clients et d’anciens logs de support. L’accès au dépôt ne rend pas automatiquement chaque fichier approprié pour un service de modèle.

Utilisez des outils approuvés et les règles de traitement des données. Excluez les secrets du contexte. Remplacez si possible les exemples clients par des données inventées. Vérifiez les outils connectés autant que les fichiers envoyés : un connecteur de recherche peut récupérer des informations absentes du prompt initial.

Une instruction « ne lisez pas les secrets » donne une consigne utile. Elle ne remplace pas la limitation des accès au stockage des secrets et aux répertoires sensibles.

Laissez une trace utile à la personne suivante

À la fin, consignez dans la pull request le comportement modifié, la vérification et les limites non résolues. Actualisez la documentation durable du projet lorsque le workflow pris en charge change. Évitez de copier tout le dialogue de l’agent dans le dépôt.

La trace doit aider une future personne chargée de la maintenance à répéter le travail sans reconstituer une longue conversation. Liez les documents de référence et conservez une description faisant autorité pour chaque règle stable.

Un bon contexte réduit les investigations répétées. Il facilite aussi la détection des erreurs parce que le comportement attendu et les commandes opérationnelles sont explicites.

Faire l’exercice

Inspectez un fichier d’instructions du dépôt. Vérifiez trois commandes dans le projet actuel. Repérez une affirmation obsolète ou une contrainte manquante. Proposez une petite correction par le processus normal de revue. N’incluez ni identifiants secrets ni données clients.

Télécharger la fiche d’exercice (Markdown)

Vérifier votre compréhension

Le guide du dépôt recommande une commande qui n’existe plus. Que doit faire l’agent ?

Sources et lectures complémentaires

Lectures Taiga sur le sujet