Skip to content

Make the agent instructions canonical in AGENTS.md - #126

Closed
juanmaguitar wants to merge 1 commit into
remove-ci-ai-reviewfrom
add-agents-md
Closed

Make the agent instructions canonical in AGENTS.md#126
juanmaguitar wants to merge 1 commit into
remove-ci-ai-reviewfrom
add-agents-md

Conversation

@juanmaguitar

@juanmaguitar juanmaguitar commented Aug 6, 2026

Copy link
Copy Markdown
Collaborator

Stacked on #125 — review that first. This diff shows only its own changes once #125 lands.

Why

CLAUDE.md was the only place this project's constraints were written down, so every agent other than Claude Code started from nothing. That matters more here than in most repos: the premise — zero host prerequisites, no git binary, electron-store as the only persistence layer — is invisible from the code alone, and an agent that does not know it will reach for spawn('git') and be pleased with the result.

What changes

  • AGENTS.md is now canonical and tool-neutral. It carries what CLAUDE.md held, plus the directive to run the review before opening a pull request and summarise the outcome in the description.
  • CLAUDE.md shrinks to a pointer plus the one genuinely Claude Code specific line, so there is no second copy to drift.

No Copilot file

An earlier version of this PR added .github/copilot-instructions.md, because Copilot reads neither AGENTS.md nor CLAUDE.md. It is gone: #125 puts the review standard at .github/instructions/code-review.instructions.md, which Copilot reads natively, and that is the part it actually needs. Everything else here is context an agent can be pointed at.

Adding one anyway would have meant a second copy of the invariants with nothing keeping the two in step — the failure mode this PR exists to remove, reintroduced one file over.

Notes

AGENTS.md says plainly that nothing enforces the pre-PR review. It is a directive, and describing it as anything firmer would be false — worth keeping that way when the next person edits it.

No stubs for Codex or Cursor: both read AGENTS.md already, and per-tool files drift. Worth adding one when a tool is actually in use, not before.

Self-review

Documentation only, no JavaScript changed. npm run lint clean, 147 tests pass. No findings across the five dimensions.

CLAUDE.md was the only place the project's constraints were written down, so
every agent other than Claude Code started from nothing — on a codebase whose
whole premise (zero host prerequisites, no git binary, one persistence layer)
is invisible from the code alone.

AGENTS.md is now canonical and CLAUDE.md points at it, keeping only what is
genuinely Claude Code specific. AGENTS.md also carries the directive to run
the review before opening a pull request, and is explicit that nothing
enforces it.

No Copilot file: the review standard already sits at a path Copilot reads
natively, and everything else here is something it can be pointed at. Adding
one would have meant a second copy of the invariants with nothing keeping the
two in step.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@juanmaguitar

Copy link
Copy Markdown
Collaborator Author

Superseded by #127 — GitHub closed this when remove-ci-ai-review was deleted on merging #125, and a closed PR cannot be reopened or retargeted once its base branch is gone. Same commit, based on trunk.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant