Leerpad 02Les 2 / 6

Geef een agent bruikbare repositorycontext

Lever actuele instructies, relevante code en werkende controleopdrachten aan zonder onnodige informatie bloot te leggen.

Praktijk9 minGereviewd

Gepubliceerd door Hoe we schrijven

Wat u leert

  • Bereid gerichte context voor een repositorytaak voor.
  • Herken verouderde of tegenstrijdige instructies.
  • Houd toegangsgegevens en niet-gerelateerde privégegevens buiten de taakcontext.

Begin bij de huidige checkout

Een agent moet weten welke repository en branch worden gewijzigd. De agent moet ook weten of de werkmap niet-gerelateerde wijzigingen bevat. Deze feiten bepalen wat veilig kan worden bewerkt en hoe de uiteindelijke diff moet worden geïnterpreteerd.

Vraag de agent vóór implementatie de projectinstructies en pakketconfiguratie te inspecteren. Een onthouden opdracht uit een andere repository kan hier onjuist zijn. Een bekende frameworknaam toont de geïnstalleerde versie of projectconventies niet aan.

Geef voor een kleine wijziging de relevante module, aanroepers, tests en het architectuurbesluit mee. Voeg informatie toe wanneer het onderzoek een concrete behoefte laat zien.

Gebruik repositoryinstructies voor vaste regels

Een instructiebestand kan ondersteunde opdrachten, modulegrenzen, revieweisen en acties waarvoor een besluit nodig is beschrijven. De AGENTS.md-conventie geeft codetools een herkenbare plek voor deze informatie. Toolondersteuning en de voorrang van instructies kunnen verschillen. Controleer daarom het gedrag van uw tool.

Bewaar vaste projectregels in de repository. Bewaar de huidige taak in de taakbeschrijving. Maak van het instructiebestand geen geschiedenis van elk gesprek of lijst met tijdelijke plannen.

Een bruikbare instructie zegt: ‘Voer de autorisatie-integratietests uit als een route het toegangsgedrag verandert.’ Een vage instructie zegt: ‘Wees altijd voorzichtig met beveiliging.’ De eerste noemt een aanleiding en een actie die een reviewer kan verifiëren.

Controleer instructies tegen de code

Instructies verouderen als opdrachten, mappen of architectuur veranderen. Inspecteer de pakketconfiguratie als een gids een ontbrekend script noemt. Inspecteer de rechten voordat u vertrouwt op een document dat een dienst als alleen-lezen beschrijft.

Leg het conflict vast. Gebruik direct bewijs over de huidige versie om het implementatiegedrag te begrijpen. Verwerp niet ongemerkt bewust beleid omdat oude code het schendt. Beleid en huidig gedrag beantwoorden verschillende vragen.

De gids kan bijvoorbeeld rechtstreeks schrijven naar een gedeelde branch verbieden terwijl een oud script dit nog doet. De juiste reactie is het beleid behouden en het script corrigeren. Bestaande code geeft geen toestemming om een verboden actie te herhalen.

Houd de context relevant en veilig

Een volledige repository kan toegangsgegevens, privétestdata, klantexports en oude supportlogs bevatten. Repositorytoegang maakt niet automatisch elk bestand geschikt voor een modeldienst.

Gebruik goedgekeurde tools en gegevensregels. Sluit secrets uit van de context. Vervang klantvoorbeelden waar mogelijk door verzonnen gegevens. Controleer gekoppelde tools én geüploade bestanden. Een zoekconnector kan informatie ophalen die nooit in de oorspronkelijke prompt stond.

Een repositoryinstructie als ‘lees geen secrets’ is bruikbare begeleiding. Ze vervangt geen beperkte toegang tot secretopslag en gevoelige mappen.

Laat bruikbare documentatie achter

Leg na afloop het gewijzigde gedrag, de verificatie en onopgeloste beperkingen vast in de pull request. Werk blijvende projectdocumentatie bij wanneer de ondersteunde workflow verandert. Kopieer niet het volledige agentgesprek naar de repository.

De documentatie moet een toekomstige beheerder helpen het werk te herhalen zonder een lang gesprek te reconstrueren. Link naar canonieke documenten en houd één gezaghebbende beschrijving van elke vaste regel.

Goede context vermindert herhaald onderzoek. Ze maakt fouten ook makkelijker te vinden doordat verwacht gedrag en werkende opdrachten expliciet zijn.

Maak de oefening

Inspecteer één instructiebestand in een repository. Verifieer drie opdrachten tegen het huidige project. Zoek één verouderde uitspraak of ontbrekende beperking. Stel via het normale reviewproces een kleine correctie voor. Neem geen toegangsgegevens of klantgegevens op.

Werkblad downloaden (Markdown)

Controleer uw begrip

De repositorygids beveelt een opdracht aan die niet meer bestaat. Wat moet de agent doen?

Bronnen en verder lezen

Gerelateerd leesmateriaal van Taiga