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