Repository navigation
docs: add agent instructions for AI coding tools - #11
Merged
Merged
Conversation
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>
…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>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Closes #7.
Summary
AGENTS.mdstays 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.AGENTS.mdnatively (no file needed).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/settings.json→context.fileName: ["AGENTS.md"]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.mdandtracking-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:AGENTS.md;npm runscript that does not exist;applyToglob 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":<type>/<n>-<slug>fromorigin/dev, PR withCloses #n);masterand PRs targetdev, soCloses #ntakes effect only when the release reachesmaster.docs/agents/checklists/milestone-audit.md: checks each issue of a milestone on evidence, not on its state:dev;milestone-auditoragent (read-only);work-on-issueskill;releaseskill: audit, version and CHANGELOG,dev→masterwithCloseslines, tag and GitHub release, then close the milestone. Every outward step needs the maintainer's confirmation.CONTRIBUTING.md: the same rules, briefly.Deviations from the issue
.agents/instructions.md. Antigravity readsAGENTS.mdnatively; its documented workspace rules location is.agents/rules/*.md, not.agents/instructions.md.GEMINI.md. The current Gemini CLI setting iscontext.fileName.check-upstreamskill, as proposed in the comment on Agent instructions for AI coding tools (Claude Code, Copilot, Gemini, Antigravity, Codex, Cursor) #7.Test plan
npm run typechecknpm test: 44 tests passnpm run buildnpm run check:agentspasses (16 files), and fails as expected on three breakages:AGENTS.md;npm run lintnamed inAGENTS.md;src/runtime/tracker/path.graph-revieweron a test diff renamingdetectionInterval→intervalwithout aGRAPH_VERSIONbump: Blocking (no bump, stalepublic/graphs/, no CHANGELOG line).tracking-revieweron a test diff moving lost-debounce logic into the worker: Blocking (worker holds state, unbalanced found / lost).milestone-auditoronv0.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 (thetestjob); not run locally.🤖 Generated with Claude Code