Skip to content

docs: add agent instructions for AI coding tools - #11

Merged
kalwalt merged 3 commits into
devfrom
feat/agent-instructions
Oct 19, 2026
Merged

kalwalt merged 3 commits into
devfrom
feat/agent-instructions

Conversation

@kalwalt

@kalwalt kalwalt commented Oct 15, 2026 •

Copy link
Copy Markdown
Member

Closes #7.

Summary

AGENTS.md stays the single source of truth. Each tool gets a thin entry point that points to it, and the review checklists are shared by all tools.

Tool Entry point
Codex, Cursor, Antigravity read AGENTS.md natively (no file needed)
GitHub Copilot .github/copilot-instructions.md (critical rules inlined, for chat and code review on github.com) and .github/instructions/{graph,tracking}.instructions.md (path-specific, applyTo)
Gemini CLI .gemini/settings.json → context.fileName: ["AGENTS.md"]
Claude Code CLAUDE.md (Claude-only notes), .claude/agents/{graph,tracking}-reviewer.md, .claude/skills/{new-node,check-upstream}

Other changes:

  • AGENTS.md: which tools read it, adding a node, test assets and the fake camera, review checklists.
  • docs/agents/checklists/: graph-review.md and tracking-review.md, tool-agnostic. The tracking checklist includes readiness for the jsartoolkitNFT facade (Adopt the jsartoolkitNFT data-oriented tracker facade (jsartoolkitNFT#720) #5).
  • scripts/check-agent-docs.mjs (npm run check:agents, run in CI). It fails when:
    • a pointer file stops linking to AGENTS.md;
    • an agent file names an npm run script that does not exist;
    • an agent file names a path, a relative link or an applyTo glob that does not exist.
  • CONTRIBUTING.md: a paragraph on keeping the agent files in sync.

Issues, milestones and releases

Added at the maintainer's request:

  • AGENTS.md → "Planning and tracking work":
    • one milestone per release;
    • how to implement an issue (branch <type>/<n>-<slug> from origin/dev, PR with Closes #n);
    • when an issue is done;
    • a milestone is closed only after its release exists.
  • Why issues stay open: the default branch is master and PRs target dev, so Closes #n takes effect only when the release reaches master.
  • docs/agents/checklists/milestone-audit.md: checks each issue of a milestone on evidence, not on its state:
    • a merged PR into dev;
    • the task list ticked;
    • the acceptance criteria met;
    • the sub-issues done;
    • CI green and the CHANGELOG updated.
  • Claude Code:
    • milestone-auditor agent (read-only);
    • work-on-issue skill;
    • release skill: audit, version and CHANGELOG, dev → master with Closes lines, tag and GitHub release, then close the milestone. Every outward step needs the maintainer's confirmation.
  • Copilot instructions and CONTRIBUTING.md: the same rules, briefly.

Deviations from the issue

Test plan

  • npm run typecheck
  • npm test: 44 tests pass
  • npm run build
  • npm run check:agents passes (16 files), and fails as expected on three breakages:
    • a pointer file without AGENTS.md;
    • npm run lint named in AGENTS.md;
    • a misspelt src/runtime/tracker/ path.
  • graph-reviewer on a test diff renaming detectionInterval → interval without a GRAPH_VERSION bump: Blocking (no bump, stale public/graphs/, no CHANGELOG line).
  • tracking-reviewer on a test diff moving lost-debounce logic into the worker: Blocking (worker holds state, unbalanced found / lost).
  • milestone-auditor on v0.1.0 — Foundation: Not ready (PR docs: add agent instructions for AI coding tools #11 not merged, feat: tracking traces, replay and debugging tools #9 not started), as expected.
  • npm run test:e2e: passed in CI (the test job); not run locally.

🤖 Generated with Claude Code

AGENTS.md stays the single source of truth; per-tool entry points point to it:

- AGENTS.md: which tools read it, adding a node, test assets and the fake
  camera, review checklists
- docs/agents/checklists: tool-agnostic graph and tracking review checklists
- Copilot: copilot-instructions.md with the critical rules inlined, plus
  path-specific instructions for graph and tracking files
- Gemini CLI: .gemini/settings.json loads AGENTS.md as its context file
- Claude Code: CLAUDE.md notes, graph-reviewer and tracking-reviewer agents,
  new-node and check-upstream skills
- scripts/check-agent-docs.mjs (npm run check:agents), run in CI
- CONTRIBUTING.md: how to keep the agent files in sync

Closes #7

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kalwalt kalwalt self-assigned this Oct 15, 2026
@kalwalt kalwalt added enhancement New feature or request AI - agents labels Oct 15, 2026
kalwalt and others added 2 commits October 16, 2026 00:25
…ents

- AGENTS.md: one milestone per release, how to implement an issue, when an
  issue is done, and closing a milestone only after its release. PRs target
  dev while the default branch is master, so Closes #n takes effect at the
  release.
- docs/agents/checklists/milestone-audit.md: tool-agnostic audit
- Claude Code: milestone-auditor agent, work-on-issue and release skills
- Copilot instructions and CONTRIBUTING.md: the same rules, briefly

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@kalwalt kalwalt added CI documentation Improvements or additions to documentation labels Oct 15, 2026
@kalwalt
kalwalt merged commit 7dd8113 into dev Oct 19, 2026
2 checks passed
@kalwalt
kalwalt deleted the feat/agent-instructions branch October 19, 2026 22:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

AI - agents CI documentation Improvements or additions to documentation enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant