Itinerari 02Lliçó 2 / 6

Doneu a l'agent un context útil del repositori

Proporcioneu instruccions actuals, codi rellevant i ordres de comprovació que funcionin, sense exposar informació innecessària.

Pràctic9 minRevisat

Publicat per Com escrivim

Comproveu què heu entèsLa guia del repositori recomana una ordre que ja no existeix. Què ha de fer l'agent?Feu l'exercici
La guia del repositori recomana una ordre que ja no existeix. Què ha de fer l'agent?

Què aprendreu

  • Preparar un conjunt de context centrat en una tasca del repositori.
  • Identificar instruccions obsoletes o contradictòries.
  • Mantenir les credencials i les dades privades no relacionades fora del context de la tasca.

Comenceu amb la còpia de treball actual

Un agent ha de saber quin repositori i quina branca està modificant. També ha de saber si el directori de treball conté canvis no relacionats. Aquests fets afecten què pot editar amb seguretat i com s’ha d’interpretar la comparació final de canvis.

Demaneu a l’agent que inspeccioni les instruccions del projecte i la configuració del paquet abans de la implementació. Una ordre que recordi d’un altre repositori pot ser incorrecta aquí. Reconèixer el nom d’un framework no acredita la versió instal·lada ni les convencions del projecte.

Per a un canvi petit, proporcioneu el mòdul rellevant, el codi que el crida, les proves i la decisió d’arquitectura. Afegiu més informació quan la investigació mostri una necessitat concreta.

Utilitzeu les instruccions del repositori per a les regles estables

Un fitxer d’instruccions pot descriure les ordres admeses, els límits entre mòduls, els requisits de revisió i les accions que requereixen la decisió d’un responsable. La convenció AGENTS.md dona a les eines de programació un lloc reconeixible per a aquesta informació. El suport de les eines i la prioritat de les instruccions poden variar, per tant comproveu el comportament de la vostra eina.

Manteniu les regles estables del projecte al repositori. Manteniu la tasca actual a l’encàrrec. No convertiu el fitxer d’instruccions en un historial de totes les converses o una llista de plans temporals.

Una instrucció útil diu: «Executeu les proves d’integració d’autorització quan una ruta canviï el comportament d’accés». Una instrucció vaga diu: «Aneu sempre amb compte amb la seguretat». La primera identifica una condició desencadenant i una acció que es poden verificar durant la revisió.

Comproveu les instruccions amb el codi

Les instruccions queden obsoletes quan canvien les ordres, els directoris o l’arquitectura. Si una guia indica un script absent, inspeccioneu la configuració del paquet. Si un document diu que un servei és de només lectura, inspeccioneu els permisos abans de confiar en l’afirmació.

Registreu el conflicte. Utilitzeu evidències directes de la versió actual per entendre el comportament de la implementació. No descarteu silenciosament una política intencionada perquè el codi antic la incompleixi. La política i el comportament actual responen preguntes diferents.

Per exemple, la guia pot prohibir escriure directament en una branca compartida mentre un script antic encara ho fa. La resposta correcta és conservar la política i corregir el script. El codi existent no dona permís per repetir una acció prohibida.

Manteniu el context rellevant i segur

Un repositori complet pot contenir credencials, dades de prova privades, exportacions de dades de clients i registres antics de suport. L’accés al repositori no fa que tots els fitxers siguin automàticament adequats per a un servei de models.

Utilitzeu eines aprovades i regles de tractament de dades. Excloeu els secrets del context. Substituïu els exemples de clients per dades inventades sempre que sigui possible. Comproveu tant les eines connectades com els fitxers carregats: un connector de cerca pot recuperar informació que no era al prompt inicial.

Una instrucció del repositori que digui «no llegiu secrets» és una directriu útil. No substitueix la limitació d’accés al sistema de secrets i als directoris sensibles.

Deixeu un registre útil per a la persona següent

En acabar, registreu a la pull request el comportament modificat, la verificació i els límits encara no resolts. Actualitzeu la documentació permanent del projecte quan canviï el flux de treball admès. Eviteu copiar tota la transcripció de l’agent al repositori.

El registre ha d’ajudar qui mantingui el sistema en el futur a repetir la feina sense reconstruir una conversa llarga. Enllaceu els documents canònics i manteniu una única descripció de referència per a cada regla estable.

Un bon context redueix les investigacions repetides. També facilita la detecció d’errors perquè el comportament esperat i les ordres que funcionen són explícits.

Feu l'exercici

Inspeccioneu un fitxer d'instruccions d'un repositori. Verifiqueu tres ordres amb el projecte actual. Trobeu una afirmació obsoleta o una restricció que falti. Proposeu una petita correcció mitjançant el procés normal de revisió. No hi inclogueu credencials ni dades de clients.

Descarrega la fitxa (Markdown)
Comproveu què heu entès ↑

Continua aprenent

Fonts i lectures addicionals

Lectures relacionades de Taiga

Lliçó anterior: Escriviu un encàrrec per a un agent