Giv en agent brugbar kontekst fra repositoryet

Start med det aktuelle checkout

En agent skal vide, hvilket repository og hvilken branch den ændrer. Den skal også vide, om arbejdsmappen indeholder uvedkommende ændringer. Det påvirker, hvad den sikkert kan redigere, og hvordan den endelige diff skal forstås.

Bed agenten om at undersøge projektets instruktioner og pakkekonfiguration før implementering. En husket kommando fra et andet repository kan være forkert her. Et velkendt frameworknavn fastslår hverken den installerede version eller projektets konventioner.

Ved en lille ændring skal du tilføje det relevante modul, den kaldende kode, tests og arkitekturbeslutningen. Tilføj mere information, når undersøgelsen viser et konkret behov.

Brug repositoryets instruktioner til varige regler

En instruktionsfil kan beskrive understøttede kommandoer, modulgrænser, reviewkrav og handlinger, der kræver en beslutning fra en ansvarlig. AGENTS.md-konventionen giver kodeværktøjer et genkendeligt sted til disse oplysninger. Værktøjsunderstøttelse og instruktionernes prioritet kan variere, så kontrollér dit værktøjs adfærd.

Opbevar varige projektregler i repositoryet. Hold den aktuelle opgave i opgavebeskrivelsen. Gør ikke instruktionsfilen til en historik over alle samtaler eller en liste over midlertidige planer.

En brugbar instruktion siger: »Kør integrationstests for rettighedskontrol, når en route ændrer adgangsadfærd.« En vag instruktion siger: »Vær altid forsigtig med sikkerhed.« Den første angiver en udløsende ændring og en handling, som en reviewer kan kontrollere.

Kontrollér instruktionerne mod koden

Instruktioner bliver forældede, når kommandoer, mapper eller arkitektur ændres. Hvis en vejledning henviser til et manglende script, skal du undersøge pakkekonfigurationen. Hvis et dokument siger, at en tjeneste kun har læseadgang, skal du undersøge rettighederne, før du stoler på påstanden.

Registrér konflikten. Brug direkte dokumentation fra den aktuelle version til at forstå implementeringens adfærd. Forkast ikke stiltiende en tilsigtet politik, fordi gammel kode bryder den. Politik og aktuel adfærd besvarer forskellige spørgsmål.

Vejledningen kan for eksempel forbyde direkte skrivning til en fælles branch, mens et gammelt script stadig gør det. Det korrekte svar er at bevare politikken og rette scriptet. Eksisterende kode er ikke tilladelse til at gentage en forbudt handling.

Hold konteksten relevant og sikker

Et helt repository kan indeholde adgangsoplysninger, private testdata, kundeeksporter og gamle supportlogs. Adgang til repositoryet gør ikke automatisk hver fil egnet til en modeltjeneste.

Brug godkendte værktøjer og regler for databehandling. Hold secrets ude af konteksten. Erstat kundeeksempler med opdigtede data, hvor det er muligt. Kontrollér også tilsluttede værktøjer, ikke kun uploadede filer. En søgeforbindelse kan hente oplysninger, der aldrig var i den oprindelige prompt.

En instruktion i repositoryet om »ikke at læse secrets« er nyttig vejledning. Den erstatter ikke begrænset adgang til opbevaring af secrets og følsomme mapper.

Efterlad brugbar dokumentation til den næste person

Når arbejdet er færdigt, skal du dokumentere den ændrede adfærd, kontrollen og de uafklarede begrænsninger i pull requesten. Opdatér varig projektdokumentation, når den understøttede arbejdsgang ændres. Undgå at kopiere hele agentsamtalen ind i repositoryet.

Dokumentationen skal hjælpe en fremtidig vedligeholder med at gentage arbejdet uden at rekonstruere en lang samtale. Link til kanoniske dokumenter, og behold én autoritativ beskrivelse af hver varig regel.

God kontekst reducerer gentagne undersøgelser. Den gør også fejl lettere at opdage, fordi den forventede adfærd og de fungerende kommandoer er udtrykkelige.