Dajte agentu koristan kontekst repozitorija
DovršenoDostavite aktualne upute, relevantan kod i funkcionalne naredbe za provjeru bez izlaganja nepotrebnih informacija.
Objavljuje TaigaKako pišemo
Provjerite razumijevanjeVodič repozitorija preporučuje naredbu koja više ne postoji. Što agent treba učiniti?Napravite vježbu
Što ćete naučiti
- Pripremiti usmjeren skup konteksta za zadatak u repozitoriju.
- Prepoznati zastarjele ili proturječne upute.
- Zadržati vjerodajnice i nepovezane privatne podatke izvan konteksta zadatka.
Počnite trenutačnom radnom kopijom
Agent treba znati koji repozitorij i granu mijenja. Treba znati i sadrži li radni direktorij nepovezane promjene. Te činjenice utječu na to što može sigurno urediti i kako treba tumačiti konačni diff.
Zatražite da agent prije implementacije pregleda upute projekta i konfiguraciju paketa. Zapamćena naredba iz drugog repozitorija ovdje može biti pogrešna. Poznat naziv okvira ne potvrđuje instaliranu verziju ni projektne konvencije.
Za malu promjenu dostavite relevantan modul, kod koji ga poziva, testove i arhitekturnu odluku. Dodajte informacije kad istraživanje pokaže konkretnu potrebu.
Stabilna pravila držite u uputama repozitorija
Datoteka uputa može opisivati podržane naredbe, granice modula, zahtjeve pregleda i radnje koje trebaju odluku odgovorne osobe. Konvencija AGENTS.md daje alatima za programiranje prepoznatljivo mjesto za te informacije. Podrška alata i prvenstvo uputa mogu se razlikovati, pa provjerite ponašanje svog alata.
Stabilna pravila projekta držite u repozitoriju. Trenutačni zadatak držite u opisu zadatka. Nemojte datoteku uputa pretvoriti u povijest svih razgovora ili popis privremenih planova.
Korisna uputa kaže „Pokrenite integracijske testove autorizacije kad ruta promijeni ponašanje pristupa.” Nejasna uputa kaže „Uvijek pazite na sigurnost.” Prva određuje povod i radnju koju pregledavatelj može provjeriti.
Usporedite upute s kodom
Upute zastarijevaju kad se promijene naredbe, direktoriji ili arhitektura. Ako vodič navodi skriptu koja nedostaje, pregledajte konfiguraciju paketa. Ako dokument tvrdi da je usluga samo za čitanje, prije oslanjanja na tvrdnju pregledajte ovlasti.
Zabilježite sukob. Izravnim dokazima o trenutačnoj verziji utvrdite ponašanje implementacije. Nemojte prešutno odbaciti namjerno pravilo zato što ga stari kod krši. Pravilo i trenutačno ponašanje odgovaraju na različita pitanja.
Primjerice, vodič može zabraniti izravno pisanje u zajedničku granu dok ga stara skripta i dalje provodi. Ispravan odgovor jest sačuvati pravilo i ispraviti skriptu. Postojeći kod nije dopuštenje za ponavljanje zabranjene radnje.
Zadržite relevantan i siguran kontekst
Cijeli repozitorij može sadržavati vjerodajnice, privatne testne podatke, izvoze klijenata i stare zapisnike podrške. Pristup repozitoriju ne čini automatski svaku datoteku prikladnom za uslugu modela.
Upotrebljavajte odobrene alate i pravila obrade podataka. Isključite tajne podatke iz konteksta. Gdje je moguće, zamijenite primjere klijenata izmišljenim podacima. Provjerite povezane alate i učitane datoteke: konektor za pretraživanje može dohvatiti informacije koje nikad nisu bile u početnom promptu.
Uputa repozitorija „nemojte čitati tajne podatke” korisna je smjernica. Ne zamjenjuje ograničavanje pristupa spremištu tajnih podataka i osjetljivim direktorijima.
Ostavite koristan zapis sljedećoj osobi
Po završetku u pull request zabilježite promijenjeno ponašanje, provjeru i neriješena ograničenja. Ažurirajte trajnu projektnu dokumentaciju kad se podržani postupak promijeni. Nemojte kopirati cijeli transkript agenta u repozitorij.
Zapis treba pomoći budućem održavatelju ponoviti rad bez rekonstruiranja dugog razgovora. Povežite kanonske dokumente i držite jedan mjerodavan opis svakog stabilnog pravila.
Dobar kontekst smanjuje ponovljeno istraživanje. Također olakšava otkrivanje pogrešaka jer su očekivano ponašanje i funkcionalne naredbe izričiti.
Napravite vježbu
Pregledajte jednu datoteku uputa repozitorija. Provjerite tri naredbe u trenutačnom projektu. Pronađite jednu zastarjelu tvrdnju ili ograničenje koje nedostaje. Predložite mali ispravak kroz uobičajeni postupak pregleda. Nemojte uključiti vjerodajnice ili podatke klijenata.
Preuzmi radni list (Markdown)Uklanjanje ove oznake briše sav napredak spremljen u ovom pregledniku.
Napredak ostaje u ovom pregledniku. Bez računa i praćenja.