From 64e8ee78f14de7c0757cdbc19f176c40cc75ada1 Mon Sep 17 00:00:00 2001 From: JuanMa Date: Thu, 6 Aug 2026 09:44:04 +0200 Subject: [PATCH] Make the agent instructions canonical in AGENTS.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 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) --- AGENTS.md | 64 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ CLAUDE.md | 27 ++++++----------------- 2 files changed, 71 insertions(+), 20 deletions(-) create mode 100644 AGENTS.md diff --git a/AGENTS.md b/AGENTS.md new file mode 100644 index 0000000..f22c934 --- /dev/null +++ b/AGENTS.md @@ -0,0 +1,64 @@ +# AGENTS.md + +Instructions for AI coding agents working in this repository. Tool-neutral and canonical — +`CLAUDE.md` points here rather than repeating it. + +The review standard is separate, in +[`.github/instructions/code-review.instructions.md`](.github/instructions/code-review.instructions.md). +It lives at that path because Copilot code review reads `.github/instructions/*.instructions.md` +natively and follows no links, so that is the only way it gets the standard without a second copy +being maintained alongside it. + +## What this is + +An Electron desktop app ("WordPress Contributor Toolkit") that sets up a full WordPress core +(`wordpress-develop`) dev environment with zero prerequisites — no Git, Node, npm, or Docker +required on the host. Everything is bundled and run as JS/WASM inside the Electron process. Built +to fix a Contributor Day problem: newcomers burning the whole session on local setup instead of +contributing. Still labeled "experimental." + +## Before opening a pull request + +Run the review in `.github/instructions/code-review.instructions.md` against the branch, and fix or +consciously defer every finding. Summarise the outcome in the pull request description — counts, +what was fixed, what was left as a follow-up and why. + +Nothing enforces this. There is no automated review on pull requests, by design: it would mean +storing an AI provider credential as a secret in a public repository. This pass is what stands in +its place, so skipping it means a human reviewer is the first reader of the diff. + +That file carries the procedure as well as the standard. Follow it rather than improvising a +review. + +## Commands + +See `package.json` scripts. To run a single test file (not exposed as a script): +`node --test test/azure-sign.test.cjs`. + +## Architecture notes (non-obvious) + +- **Child processes run on Electron's own Node, not the system Node.** `npm install`, + `npm run