Skip to content

AGENTS.md

Latest commit

 

History

History
56 lines (42 loc) · 1.55 KB

AGENTS.md

File metadata and controls

56 lines (42 loc) · 1.55 KB

AGENTS.md

This file is the contract for any coding agent operating in this repository.

Source of truth

Humans:

  • STATUS.md
  • TASKS.md
  • optional WORKLOG.md

Automation:

  • .agent/runs/*.json
  • .agent/index.json

Task workflow

  1. Choose a task from TASKS.md that has a stable ID like T-001.
  2. If the task is not in Doing, move it to Doing and set status to [doing].
  3. Implement changes.
  4. Run make ci (or document why it cannot be run).
  5. Update state:
    • Update TASKS.md (status, completion stamp, and link to run record).
    • Update STATUS.md (Now, Active, Blockers, Last update).
    • Append a short note in WORKLOG.md if the change is user-facing.
  6. Write a run record: .agent/runs/YYYY-MM-DDThh-mm-ssZ_<task_id>.json.
  7. Update .agent/index.json (or run python scripts/update_agent_index.py).

Definition of done

A task is done only when:

  • make ci passes, OR the run record clearly explains why it could not be run
  • the run record exists in .agent/runs/
  • TASKS.md references that run record and includes a completion date
  • STATUS.md reflects the new repo state

Makefile contract

Prefer Make targets over raw commands.

Required targets:

  • make help
  • make setup
  • make fmt
  • make lint
  • make test
  • make ci

If targets are missing, create them as part of your work.

Editing rules

  • Keep STATUS.md short, it should fit on one screen.
  • Keep tasks small and specific.
  • Never mark a task done without a run record link.
  • If you changed behavior, update docs in README.md or examples/.