Parcurs 02Lecție 2 / 6

Oferiți agentului context util din depozitul de cod

Furnizați instrucțiuni actuale, cod relevant și comenzi de verificare funcționale fără a expune informații inutile.

Practică9 minVerificat

Publicat de Cum scriem

Verificați ce ați înțelesGhidul depozitului de cod recomandă o comandă care nu mai există. Ce trebuie să facă agentul?Faceți exercițiul
Ghidul depozitului de cod recomandă o comandă care nu mai există. Ce trebuie să facă agentul?

Ce veți învăța

  • Pregătiți un set de context concentrat pentru o sarcină din depozitul de cod.
  • Identificați instrucțiunile depășite sau contradictorii.
  • Excludeți credențialele și datele private fără legătură din contextul sarcinii.

Începeți cu copia de lucru actuală

Un agent trebuie să știe ce depozit de cod și ce branch modifică. Trebuie și să știe dacă directorul de lucru conține modificări fără legătură cu sarcina. Aceste fapte afectează ce poate edita în siguranță și cum trebuie interpretat diff-ul final.

Cereți agentului să inspecteze instrucțiunile proiectului și configurația pachetelor înainte de implementare. O comandă reținută din alt depozit de cod poate fi greșită aici. Numele familiar al unui framework nu stabilește versiunea instalată sau convențiile proiectului.

Pentru o modificare mică, furnizați modulul relevant, codul apelant, testele și decizia de arhitectură. Adăugați informații când investigația arată o nevoie concretă.

Folosiți instrucțiunile depozitului pentru reguli stabile

Un fișier de instrucțiuni poate descrie comenzile acceptate, limitele modulelor, cerințele de verificare și acțiunile care necesită decizia unui responsabil. Convenția AGENTS.md oferă instrumentelor de programare un loc ușor de recunoscut pentru aceste informații. Suportul instrumentelor și ordinea de prioritate a instrucțiunilor pot varia, deci verificați comportamentul instrumentului folosit.

Păstrați regulile stabile ale proiectului în depozitul de cod. Păstrați sarcina curentă în descrierea sarcinii. Nu transformați fișierul de instrucțiuni într-un istoric al tuturor conversațiilor sau într-o listă de planuri temporare.

O instrucțiune utilă spune: „Executați testele de integrare pentru autorizare când o rută schimbă comportamentul de acces.” O instrucțiune vagă spune: „Aveți mereu grijă la securitate.” Prima identifică un declanșator și o acțiune care poate fi verificată.

Verificați instrucțiunile în raport cu codul

Instrucțiunile devin depășite când se schimbă comenzile, directoarele sau arhitectura. Dacă un ghid numește un script lipsă, inspectați configurația pachetului. Dacă un document spune că un serviciu permite doar citire, inspectați permisiunile înainte de a vă baza pe afirmație.

Consemnați conflictul. Folosiți dovezi directe despre versiunea actuală pentru a înțelege comportamentul implementării. Nu ignorați în tăcere o politică intenționată deoarece codul vechi o încalcă. Politica și comportamentul actual răspund la întrebări diferite.

De exemplu, ghidul poate interzice scrierea directă pe un branch comun, deși un script vechi încă o face. Răspunsul corect este păstrarea politicii și corectarea scriptului. Codul existent nu acordă permisiunea de a repeta o acțiune interzisă.

Păstrați contextul relevant și sigur

Un depozit de cod complet poate conține credențiale, seturi private de date pentru teste, exporturi de clienți și loguri vechi de suport. Accesul la depozitul de cod nu face automat fiecare fișier potrivit pentru un serviciu de modele.

Folosiți instrumente aprobate și regulile de prelucrare a datelor. Excludeți secretele din context. Înlocuiți exemplele despre clienți cu date inventate când este posibil. Verificați și instrumentele conectate, nu doar fișierele încărcate: un conector de căutare poate obține informații care nu au fost niciodată în promptul inițial.

O instrucțiune din depozitul de cod care spune „nu citiți secrete” este utilă. Nu înlocuiește limitarea accesului la spațiul de stocare a secretelor și la directoarele sensibile.

Lăsați o consemnare utilă pentru următoarea persoană

La terminare, consemnați în pull request comportamentul modificat, verificarea și limitele nerezolvate. Actualizați documentația durabilă a proiectului când se schimbă fluxul de lucru acceptat. Evitați copierea întregii conversații cu agentul în depozitul de cod.

Consemnarea trebuie să ajute o persoană care asigură mentenanța să repete lucrul fără a reconstrui o conversație lungă. Includeți legături către documentele canonice și păstrați o singură descriere de referință pentru fiecare regulă stabilă.

Contextul bun reduce investigațiile repetate. Face și greșelile mai ușor de detectat, deoarece comportamentul așteptat și comenzile funcționale sunt explicite.

Faceți exercițiul

Inspectați un fișier de instrucțiuni dintr-un depozit de cod. Verificați trei comenzi în proiectul actual. Găsiți o afirmație depășită sau o constrângere lipsă. Propuneți o corecție mică prin procesul normal de verificare. Nu includeți credențiale sau date despre clienți.

Descărcați fișa de lucru (Markdown)
Verificați ce ați înțeles ↑

Continuați învățarea

Surse și lecturi suplimentare

Lecturi asociate de la Taiga

← Lecția anterioară: Scrieți o descriere de sarcină pentru un agent