Læringsløp 02Leksjon 2 / 6

Gi en agent nyttig repositorykontekst

Gi oppdaterte instruksjoner, relevant kode og fungerende kontrollkommandoer uten å eksponere unødvendig informasjon.

Praktisk9 minGjennomgått

Publisert av Slik skriver vi

Dette lærer du

  • Forbered et fokusert kontekstsett for en repositoryoppgave.
  • Identifiser utdaterte eller motstridende instruksjoner.
  • Hold påloggingsopplysninger og uvedkommende private data utenfor oppgavekonteksten.

Start med den aktuelle arbeidskopien

En agent må vite hvilket repository og hvilken branch den endrer. Den må også vite om arbeidskatalogen inneholder andre endringer. Dette påvirker hva den trygt kan redigere, og hvordan den endelige diffen skal tolkes.

Be agenten undersøke prosjektinstruksjoner og pakkekonfigurasjon før implementering. En husket kommando fra et annet repository kan være feil her. Et kjent rammeverksnavn dokumenterer ikke installert versjon eller prosjektkonvensjoner.

For en liten endring oppgir du relevant modul, kallende kode, tester og arkitekturbeslutning. Legg til informasjon når undersøkelsen viser et konkret behov.

Bruk repositoryinstruksjoner til stabile regler

En instruksjonsfil kan beskrive støttede kommandoer, modulgrenser, reviewkrav og handlinger som krever en eiers beslutning. AGENTS.md-konvensjonen gir kodeverktøy et gjenkjennelig sted for informasjonen. Verktøystøtte og instruksjonshierarki kan variere, så kontroller verktøyets atferd.

Bevar stabile prosjektregler i repositoryet. Bevar den aktuelle oppgaven i oppgavebeskrivelsen. Ikke gjør instruksjonsfilen til en historikk over hver samtale eller en liste med midlertidige planer.

En nyttig instruksjon sier: «Kjør integrasjonstestene for autorisasjon når en route endrer tilgangsatferd.» En vag instruksjon sier: «Vær alltid forsiktig med sikkerhet.» Den første identifiserer en utløser og en handling som en reviewer kan verifisere.

Kontroller instruksjonene mot koden

Instruksjoner blir utdaterte når kommandoer, kataloger eller arkitektur endres. Hvis en veiledning angir et manglende skript, undersøk pakkekonfigurasjonen. Hvis et dokument sier at en tjeneste bare har lesetilgang, undersøk tillatelsene før du stoler på påstanden.

Registrer konflikten. Bruk direkte dokumentasjon om aktuell versjon til å forstå implementeringens atferd. Ikke forkast en bevisst policy uten å si fra fordi gammel kode bryter den. Policy og nåværende atferd besvarer ulike spørsmål.

Veiledningen kan for eksempel forby direkte skriving til en delt branch, mens et gammelt skript fortsatt gjør det. Riktig respons er å bevare policyen og rette skriptet. Eksisterende kode gir ikke tillatelse til å gjenta en forbudt handling.

Hold konteksten relevant og trygg

Et helt repository kan inneholde påloggingsopplysninger, private testdata, kundeeksporter og gamle supportlogger. Repositorytilgang gjør ikke automatisk hver fil egnet for en modelltjeneste.

Bruk godkjente verktøy og regler for databehandling. Utelat hemmeligheter fra konteksten. Erstatt kundeeksempler med oppdiktede data der det er mulig. Kontroller tilkoblede verktøy så vel som opplastede filer: En søkekobling kan hente informasjon som aldri sto i den første prompten.

En repositoryinstruksjon som sier «ikke les hemmeligheter», er nyttig veiledning. Den erstatter ikke begrenset tilgang til hemmelighetslagring og sensitive kataloger.

Etterlat en nyttig registrering for neste person

Registrer endret atferd, verifisering og uløste begrensninger i pull requesten når arbeidet er ferdig. Oppdater varig prosjektdokumentasjon når den støttede arbeidsflyten endres. Unngå å kopiere hele agentsamtalen inn i repositoryet.

Registreringen skal hjelpe en fremtidig vedlikeholder med å gjenta arbeidet uten å rekonstruere en lang samtale. Lenk til kanoniske dokumenter, og behold én autoritativ beskrivelse av hver stabil regel.

God kontekst reduserer gjentatte undersøkelser. Den gjør også feil lettere å oppdage fordi forventet atferd og fungerende kommandoer er tydelige.

Gjør øvelsen

Undersøk én instruksjonsfil i et repository. Verifiser tre kommandoer mot det aktuelle prosjektet. Finn ett utdatert utsagn eller én manglende begrensning. Foreslå en liten rettelse gjennom vanlig gjennomgangsprosess. Ikke ta med påloggingsopplysninger eller kundedata.

Last ned arbeidsark (Markdown)

Kontroller forståelsen din

Repositoryveiledningen anbefaler en kommando som ikke lenger finnes. Hva bør agenten gjøre?

Kilder og videre lesning

Relatert lesning fra Taiga