Lärstig 02Lektion 2 / 6

Ge en agent användbar repositorykontext

Tillför aktuella instruktioner, relevant kod och fungerande kontrollkommandon utan att exponera onödig information.

Praktisk nivå9 minGranskad

Publicerad av Så skriver vi

Det här lär du dig

  • Förbered en fokuserad kontext för en repositoryuppgift.
  • Identifiera föråldrade eller motstridiga instruktioner.
  • Håll autentiseringsuppgifter och orelaterade privata data utanför uppgiftens kontext.

Börja med den aktuella arbetskopian

En agent behöver veta vilket repository och vilken branch den ändrar. Den behöver också veta om arbetskatalogen innehåller orelaterade ändringar. Fakta påverkar vad den säkert kan redigera och hur den slutliga diffen ska tolkas.

Be agenten granska projektinstruktioner och paketkonfiguration före implementation. Ett ihågkommet kommando från ett annat repository kan vara fel här. Ett bekant ramverksnamn fastställer inte installerad version eller projektkonventioner.

För en liten ändring ska du tillföra relevant modul, anropare, tester och arkitekturbeslut. Lägg till information när undersökningen visar ett konkret behov.

Använd repositoryinstruktioner för stabila regler

En instruktionsfil kan beskriva stödda kommandon, modulgränser, granskningskrav och åtgärder som kräver beslut från en ansvarig. AGENTS.md-konventionen ger kodverktyg en igenkännbar plats för informationen. Verktygsstöd och instruktioners företräde kan variera, så kontrollera verktygets beteende.

Behåll stabila projektregler i repositoryt. Behåll den aktuella uppgiften i uppgiftsbeskrivningen. Gör inte instruktionsfilen till en historik över alla samtal eller en lista med tillfälliga planer.

En användbar instruktion säger ”Kör integrationstesterna för auktorisering när en route ändrar åtkomstbeteende.” En vag instruktion säger ”Var alltid försiktig med säkerhet.” Den första anger en utlösande förändring och en åtgärd som granskaren kan verifiera.

Kontrollera instruktionerna mot koden

Instruktioner blir föråldrade när kommandon, kataloger eller arkitektur ändras. Om en guide anger ett saknat skript ska du granska paketkonfigurationen. Om ett dokument säger att en tjänst bara kan läsa ska du granska behörigheterna innan du förlitar dig på påståendet.

Dokumentera konflikten. Använd direkt underlag om aktuell version för att förstå implementationsbeteendet. Kasta inte tyst bort en avsiktlig policy för att gammal kod bryter mot den. Policy och aktuellt beteende besvarar olika frågor.

Guiden kan till exempel förbjuda direkt skrivning till en delad branch medan ett gammalt skript fortfarande gör det. Rätt svar är att bevara policyn och rätta skriptet. Befintlig kod ger inte tillstånd att upprepa en förbjuden åtgärd.

Håll kontexten relevant och säker

Ett helt repository kan innehålla autentiseringsuppgifter, privata testdata, kundexporter och gamla supportloggar. Repositoryåtkomst gör inte automatiskt varje fil lämplig för en modelltjänst.

Använd godkända verktyg och regler för datahantering. Uteslut hemligheter från kontexten. Ersätt kundexempel med påhittade data där det går. Kontrollera anslutna verktyg och uppladdade filer: en sökanslutning kan hämta information som aldrig fanns i den första prompten.

En repositoryinstruktion som säger ”läs inte hemligheter” är användbar vägledning. Den ersätter inte begränsad åtkomst till hemlighetslagring och känsliga kataloger.

Lämna ett användbart underlag till nästa person

Dokumentera ändrat beteende, verifiering och olösta begränsningar i pull requesten när arbetet är klart. Uppdatera bestående projektdokumentation när det stödda arbetsflödet ändras. Undvik att kopiera hela agentsamtalet till repositoryt.

Underlaget ska hjälpa en framtida underhållsansvarig att upprepa arbetet utan att återskapa ett långt samtal. Länka till kanoniska dokument och behåll en auktoritativ beskrivning av varje stabil regel.

Bra kontext minskar upprepad undersökning. Den gör också misstag lättare att upptäcka eftersom förväntat beteende och fungerande kommandon är uttryckliga.

Gör övningen

Granska en instruktionsfil i ett repository. Verifiera tre kommandon mot det aktuella projektet. Hitta ett föråldrat påstående eller en saknad begränsning. Föreslå en liten rättning genom ordinarie granskning. Ta inte med autentiseringsuppgifter eller kunddata.

Ladda ned övningsblad (Markdown)

Kontrollera din förståelse

Repositoryguiden rekommenderar ett kommando som inte längre finns. Vad ska agenten göra?

Källor och vidare läsning

Relaterad läsning från Taiga