Anna agendile kasulik koodihoidla kontekst

Alusta praegusest töökopiast

Agent peab teadma, millist koodihoidlat ja haru ta muudab. Samuti peab ta teadma, kas töökataloog sisaldab mitteseotud muudatusi. Need faktid mõjutavad seda, mida ta saab ohutult muuta ja kuidas lõplikku diffi tõlgendada.

Palu agendil enne teostust uurida projekti juhiseid ja paketi konfiguratsiooni. Teisest koodihoidlast meelde jäänud käsk võib siin vale olla. Tuttav raamistiku nimi ei tõenda paigaldatud versiooni ega projekti tavasid.

Väikese muudatuse jaoks anna asjakohane moodul, kutsujad, testid ja arhitektuuriotsus. Lisa teavet siis, kui uurimine näitab konkreetset vajadust.

Kasuta püsireeglite jaoks koodihoidla juhiseid

Juhisefail võib kirjeldada toetatud käske, moodulipiire, ülevaatusnõudeid ja toiminguid, mis vajavad vastutaja otsust. AGENTS.md tava annab kooditööriistadele selle teabe jaoks äratuntava koha. Tööriistade tugi ja juhiste prioriteet võivad erineda, seega kontrolli oma tööriista käitumist.

Hoia projekti püsireeglid koodihoidlas. Hoia praegune ülesanne ülesandekirjelduses. Ära muuda juhisefaili kõigi vestluste ajalooks või ajutiste plaanide loendiks.

Kasulik juhis ütleb: „Käivita autoriseerimise integratsioonitestid, kui marsruut muudab juurdepääsukäitumist.” Ebamäärane juhis ütleb: „Ole turvalisusega alati ettevaatlik.” Esimene nimetab käivitava tingimuse ja toimingu, mida ülevaataja saab kontrollida.

Võrdle juhiseid koodiga

Juhised aeguvad, kui käsud, kataloogid või arhitektuur muutuvad. Kui juhend nimetab puuduvat skripti, uuri paketi konfiguratsiooni. Kui dokument ütleb, et teenus on ainult lugemiseks, kontrolli õigusi enne sellele väitele tuginemist.

Registreeri vastuolu. Kasuta praeguse versiooni otseseid tõendeid, et mõista teostuse käitumist. Ära jäta tahtlikku reeglit vaikimisi kõrvale, sest vana kood seda rikub. Reegel ja praegune käitumine vastavad erinevatele küsimustele.

Näiteks võib juhend keelata otse ühisesse harusse kirjutamise, kuigi vana skript teeb seda endiselt. Õige vastus on reegli säilitamine ja skripti parandamine. Olemasolev kood ei anna luba keelatud toimingut korrata.

Hoia kontekst asjakohane ja turvaline

Terve koodihoidla võib sisaldada autentimisandmeid, privaatseid testandmeid, kliendieksporte ja vanu tugilogisid. Koodihoidla juurdepääs ei muuda iga faili automaatselt mudeliteenuse jaoks sobivaks.

Kasuta heakskiidetud tööriistu ja andmekäitlusreegleid. Jäta saladused kontekstist välja. Asenda kliendinäited võimaluse korral väljamõeldud andmetega. Kontrolli ühendatud tööriistu samamoodi nagu üles laaditud faile: otsinguliides võib hankida teavet, mida algses promptis polnud.

Koodihoidla juhis „ära loe saladusi” on kasulik suunis. See ei asenda juurdepääsu piiramist saladustehoidlale ja tundlikele kataloogidele.

Jäta järgmisele inimesele kasulik kirje

Lõpus kirjelda pull request’is muutunud käitumist, kontrolli ja lahtisi piiranguid. Uuenda püsivat projektidokumentatsiooni, kui toetatud töövoog muutub. Väldi kogu agendivestluse kopeerimist koodihoidlasse.

Kirje peaks aitama tulevasel hooldajal tööd korrata pikka vestlust taastamata. Viita kanoonilistele dokumentidele ja hoia iga püsireegli kohta üht autoriteetset kirjeldust.

Hea kontekst vähendab korduvat uurimist. See teeb ka vead lihtsamini tuvastatavaks, sest oodatav käitumine ja töötavad käsud on selged.