Leiðbeiningar fyrir erindreka (AGENTS.md)

Hvað AGENTS.md er og hvernig erindrekar nota slíka leiðbeiningaskrá í gagnageymslu.

AGENTS.md er leiðbeiningaskrá fyrir erindreka sem vinna í gagnageymslu. Hún segir agentinum hvernig hann á að haga sér í þessu tiltekna verkefni: hvaða skrár eru source, hvað má ekki snerta, hvernig á að vinna með branches og hvenær á að vara notandann við.

Hugsið um AGENTS.md sem „verkefnareglur fyrir erindreka”, ekki sem almennan README fyrir fólk. Hún á að vera stutt, skýr og aðgerðamiðuð.

Hvernig nota erindrekar slíkar skrár?

Mismunandi tól nota leiðbeiningaskrár með aðeins ólíkum hætti. Codex les AGENTS.md áður en það byrjar að vinna og notar skrár nær núverandi möppu sem sértækari leiðbeiningar.1 Claude Code notar fyrst og fremst CLAUDE.md, en getur importað AGENTS.md ef repo-ið notar slíka skrá.2

Í námskeiðinu notum við heitið AGENTS.md sem almenna leið til að skrifa niður verkefnareglur fyrir erindreka. Ef hópur notar tól sem styður aðra skrá, til dæmis CLAUDE.md, má afrita eða vísa í sömu reglur þar.

Hvað á að vera í AGENTS.md?

Gott AGENTS.md segir agentinum:

  • að vinna á branch, ekki beint á main,
  • að halda hverri breytingu afmarkaðri,
  • að vara við ef verkefnið er orðið of stórt fyrir eitt Pull Request,
  • að breyta source-skrám frekar en afleiddum skrám,
  • að forðast lykla, leyndarmál, stór gögn og local stillingar,
  • hvernig á að prófa Quarto/GitHub Pages breytingar,
  • hvenær á að uppfæra AGENT_LOG.md.

Dæmi um góða reglu

- Work on a branch, never directly on `main`.
- Keep each branch scoped to one clear, reviewable task.
- If the task is becoming too broad for one PR, warn the user and suggest splitting it.

Þetta er betra en löng almenn lýsing, því agentinn fær skýra hegðunarreglu sem er hægt að fylgja.

Hvað á ekki að vera þar?

AGENTS.md á ekki að vera allt námskeiðið í einni skrá. Setjið frekar í README.md eða CONTRIBUTING.md:

  • almennar leiðbeiningar til nemenda,
  • nákvæma uppsetningu Quarto,
  • lýsingu á skilum,
  • löng kennslutexta um Git.

AGENTS.md á að svara spurningunni: hvernig á agent að vinna hér án þess að skemma workflowið?

Sniðmát

Sniðmát er í templates/AGENTS.md.

  1. OpenAI, Custom instructions with AGENTS.md.↩︎

  2. Anthropic, How Claude remembers your project.↩︎