Dodiet aģentam noderīgu repozitorija kontekstu

Sāciet ar pašreizējo darba kopiju

Aģentam jāzina, kuru repozitoriju un zaru tas maina. Tam arī jāzina, vai darba direktorijā ir nesaistītas izmaiņas. Šie fakti ietekmē to, ko aģents var droši rediģēt un kā jāsaprot galīgais diff.

Pirms īstenošanas lūdziet aģentam pārbaudīt projekta instrukcijas un pakotnes konfigurāciju. No cita repozitorija atcerēta komanda šeit var būt nepareiza. Pazīstams ietvara nosaukums nepierāda instalēto versiju vai projekta vienošanās.

Nelielai izmaiņai sniedziet attiecīgo moduli, izsaucējus, testus un arhitektūras lēmumu. Pievienojiet informāciju, kad izpēte atklāj konkrētu vajadzību.

Stabilus noteikumus glabājiet repozitorija instrukcijās

Instrukciju fails var aprakstīt atbalstītās komandas, moduļu robežas, pārskatīšanas prasības un darbības, kurām vajag atbildīgā lēmumu. AGENTS.md vienošanās dod programmēšanas rīkiem atpazīstamu vietu šai informācijai. Rīku atbalsts un instrukciju prioritāte var atšķirties, tāpēc pārbaudiet sava rīka darbību.

Stabilus projekta noteikumus glabājiet repozitorijā. Pašreizējo uzdevumu glabājiet uzdevuma aprakstā. Nepārvērtiet instrukciju failu par visu sarunu vēsturi vai pagaidu plānu sarakstu.

Noderīga instrukcija saka: „Palaidiet autorizācijas integrācijas testus, kad maršruts maina piekļuves darbību.“ Neskaidra instrukcija saka: „Vienmēr uzmanieties ar drošību.“ Pirmā nosaka ierosinātāju un darbību, ko pārskatītājs var pārbaudīt.

Pārbaudiet instrukciju atbilstību kodam

Instrukcijas noveco, kad mainās komandas, direktoriji vai arhitektūra. Ja ceļvedī nosaukts trūkstošs skripts, pārbaudiet pakotnes konfigurāciju. Ja dokuments saka, ka pakalpojums paredzēts tikai lasīšanai, pārbaudiet tiesības, pirms paļaujaties uz šo apgalvojumu.

Reģistrējiet pretrunu. Lai saprastu īstenojuma darbību, izmantojiet tiešus pierādījumus par pašreizējo versiju. Klusējot neatmetiet apzinātu politiku tāpēc, ka vecais kods to pārkāpj. Politika un pašreizējā darbība atbild uz atšķirīgiem jautājumiem.

Piemēram, ceļvedis var aizliegt tiešu rakstīšanu koplietojamā zarā, kamēr vecs skripts to joprojām veic. Pareiza rīcība ir saglabāt politiku un izlabot skriptu. Esošs kods nav atļauja atkārtot aizliegtu darbību.

Saglabājiet kontekstu atbilstošu un drošu

Viss repozitorijs var saturēt piekļuves datus, privātus testa datus, klientu eksportus un vecus atbalsta žurnālus. Piekļuve repozitorijam automātiski nepadara katru failu piemērotu modeļa pakalpojumam.

Izmantojiet apstiprinātus rīkus un datu apstrādes noteikumus. Neiekļaujiet slepenos datus kontekstā. Kur iespējams, aizstājiet klientu piemērus ar izdomātiem datiem. Pārbaudiet pievienotos rīkus, ne tikai augšupielādētos failus: meklēšanas savienotājs var iegūt informāciju, kuras sākotnējā uzvednē nebija.

Repozitorija instrukcija „nelasīt slepenos datus“ ir noderīga norāde. Tā neaizstāj piekļuves ierobežošanu slepeno datu glabātuvei un sensitīvām direktorijām.

Atstājiet noderīgu ierakstu nākamajam cilvēkam

Darba beigās pull request reģistrējiet mainīto darbību, pārbaudi un neatrisinātos ierobežojumus. Atjauniniet ilgtermiņa projekta dokumentāciju, kad mainās atbalstītā darbplūsma. Nekopējiet visu aģenta sarunas pierakstu repozitorijā.

Ierakstam jāpalīdz nākamajam uzturētājam atkārtot darbu, neatjaunojot garu sarunu. Sniedziet saites uz kanoniskajiem dokumentiem un saglabājiet vienu autoritatīvu katra stabilā noteikuma aprakstu.

Labs konteksts samazina atkārtotu izpēti. Tas arī atvieglo kļūdu atklāšanu, jo paredzētā darbība un darbojošās komandas ir skaidri norādītas.