Agentu dajte uporaben kontekst repozitorija

Začnite s trenutno delovno kopijo

Agent mora vedeti, kateri repozitorij in vejo spreminja. Vedeti mora tudi, ali delovna mapa vsebuje nepovezane spremembe. Ta dejstva vplivajo na to, kaj lahko varno ureja in kako je treba razlagati končni diff.

Pred izvedbo naj agent pregleda navodila projekta in konfiguracijo paketov. Ukaz, ki ga pozna iz drugega repozitorija, je lahko tukaj napačen. Znano ime ogrodja ne dokazuje nameščene različice ali pravil projekta.

Za majhno spremembo priložite ustrezni modul, kodo, ki ga kliče, teste in arhitekturno odločitev. Dodatne informacije dodajte, ko preiskava pokaže določeno potrebo.

Trajna pravila hranite v navodilih repozitorija

Datoteka z navodili lahko opisuje podprte ukaze, meje modulov, zahteve za pregled in dejanja, ki potrebujejo odločitev odgovorne osebe. Konvencija AGENTS.md daje orodjem za programiranje prepoznavno mesto za te informacije. Podpora orodij in prednostni vrstni red navodil se lahko razlikujeta, zato preverite delovanje svojega orodja.

Trajna pravila projekta hranite v repozitoriju. Trenutno nalogo ohranite v opisu naloge. Datoteke z navodili ne spreminjajte v zgodovino vseh pogovorov ali seznam začasnih načrtov.

Uporabno navodilo pravi: »Izvedite integracijske teste avtorizacije, ko pot spremeni delovanje dostopa.« Nejasno navodilo pravi: »Vedno pazite na varnost.« Prvo določa sprožilec in dejanje, ki ju pregledovalec lahko preveri.

Navodila preverite glede na kodo

Navodila zastarajo, ko se spremenijo ukazi, mape ali arhitektura. Če vodič navaja manjkajočo skripto, preglejte konfiguracijo paketov. Če dokument pravi, da ima storitev samo dostop za branje, pred zanašanjem na trditev preglejte dovoljenja.

Zabeležite neskladje. Za razumevanje izvedenega delovanja uporabite neposredne dokaze o trenutni različici. Namernega pravila ne zavrzite neopazno zato, ker ga stara koda krši. Pravila in trenutno delovanje odgovarjajo na različna vprašanja.

Vodič lahko na primer prepoveduje neposredno pisanje v skupno vejo, stara skripta pa ga še vedno izvaja. Pravilen odziv je ohranitev pravila in popravek skripte. Obstoječa koda ni dovoljenje za ponovitev prepovedanega dejanja.

Kontekst naj bo ustrezen in varen

Celoten repozitorij lahko vsebuje poverilnice, zasebne testne podatke, izvoze podatkov strank in stare dnevnike podpore. Dostop do repozitorija ne pomeni samodejno, da je vsaka datoteka primerna za storitev modela.

Uporabljajte odobrena orodja in pravila ravnanja s podatki. Skrivnosti izključite iz konteksta. Kjer je mogoče, primere strank nadomestite z izmišljenimi podatki. Poleg naloženih datotek preverite tudi povezana orodja: iskalni povezovalnik lahko pridobi informacije, ki niso bile nikoli v začetnem pozivu.

Navodilo repozitorija »ne berite skrivnosti« je uporabna usmeritev. Ne nadomesti omejitve dostopa do shrambe skrivnosti in občutljivih map.

Pustite uporaben zapis za naslednjo osebo

Ob zaključku v pull requestu zabeležite spremenjeno delovanje, preverjanje in nerešene omejitve. Ko se podprti delovni tok spremeni, posodobite trajno dokumentacijo projekta. Celotnega prepisa agentovega pogovora ne kopirajte v repozitorij.

Zapis naj prihodnjemu vzdrževalcu pomaga ponoviti delo, ne da bi moral rekonstruirati dolg pogovor. Povežite kanonične dokumente in za vsako trajno pravilo ohranite en merodajen opis.

Dober kontekst zmanjša ponavljanje preiskav. Napake je tudi lažje zaznati, ker so pričakovano delovanje in delujoči ukazi izrecno navedeni.