Skip to content

docs: Add plugin-structure instructions, CLAUDE.md, and clean up scratch file#370

Draft
Copilot wants to merge 2 commits into
developfrom
copilot/restart-work-on-instructions
Draft

docs: Add plugin-structure instructions, CLAUDE.md, and clean up scratch file#370
Copilot wants to merge 2 commits into
developfrom
copilot/restart-work-on-instructions

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 20, 2026

Completes the stalled instructions work by adding two missing referenced files and removing a leftover scratch file from the repo root.

Linked issues

Relates to #

What changed

  • .github/instructions/plugin-structure.instructions.md — new org-wide instruction file for WordPress block plugin structure: canonical directory layout (single- and multi-block), block.json conventions ($schema, apiVersion: 3, automatic asset loading via register_block_type()), editor/front-end asset separation, security (sanitize/escape/nonces), i18n (POT + JSON pipeline), and PHP class organisation
  • CLAUDE.md — new repo-root file providing Claude AI with project context, dev commands, key conventions, and boundary rules; companion to the existing AGENTS.md
  • AGENTS.md — added CLAUDE.md entry to the Cross-References & Discoverability table for bidirectional linking
  • Copilot-Processing.md — removed from repo root (moved to .github/tmp/, which is gitignored)

Audience & placement

  • Audience: contributors, AI agents (Claude, Copilot, Codex)
  • Location: .github/instructions/, repo root

Preview / Screenshots

N/A — documentation only.

Notes

Changelog

Added

  • plugin-structure.instructions.md: org-wide WordPress block plugin structure conventions covering directory layout, block.json, asset enqueueing, security, and i18n.
  • CLAUDE.md: Claude AI companion instructions at repo root, covering repo purpose, dev commands, boundary rules, and key conventions.

Changed

  • AGENTS.md: added CLAUDE.md entry to the Cross-References & Discoverability table.

Fixed

Removed

  • Copilot-Processing.md scratch file removed from repo root.

Checklist (Global DoD / PR)

  • All AC met and demonstrated
  • Tests added/updated (unit/E2E as appropriate)
  • A11y considerations addressed where relevant
  • Docs/readme/changelog updated (if user-facing)
  • Security/perf impact reviewed where relevant
  • Code/design reviews approved
  • CI green; linked issues closed; release notes prepared (if shipping)

Original prompt

can you restart this work and complete it?

The user has attached the following file paths as relevant context:

  • .github/instructions/plugin-structure.instructions.md
  • .github/instructions/.archive/file-management.instructions.md
  • .github/instructions/a11y.instructions.md
  • .github/instructions/coding-standards.instructions.md
  • .github/instructions/copilot-operations.instructions.md
  • .github/instructions/file-organisation.instructions.md
  • .github/instructions/labeling.instructions.md
  • .github/instructions/self-explanatory-code-commenting.instructions.md
  • .github/instructions/spec-driven-workflow.instructions.md
  • .github/instructions/tasksync.instructions.md
  • .github/copilot-instructions.md
  • .github/copilot-instructions.md
  • AGENTS.md
  • AGENTS.md
  • CLAUDE.md
  • AGENTS.md
  • CLAUDE.md
  • AGENTS.md
  • CLAUDE.md

Created from VS Code.

- Create .github/instructions/plugin-structure.instructions.md with
  WordPress block plugin structure conventions (directory layout,
  block.json, enqueueing, security, i18n, PHP organisation)
- Create CLAUDE.md at repo root as Claude AI companion to AGENTS.md
- Remove Copilot-Processing.md scratch file from repo root
  (moved to .github/tmp/ which is gitignored)
- Update AGENTS.md cross-references table to include CLAUDE.md entry

Agent-Logs-Url: https://github.com/lightspeedwp/.github/sessions/bedf8bf7-2de3-473b-a489-e45580925aee

Co-authored-by: ashleyshaw <1805352+ashleyshaw@users.noreply.github.com>
Copilot AI changed the title [WIP] Restart and complete work on instructions docs: Add plugin-structure instructions, CLAUDE.md, and clean up scratch file May 20, 2026
Copilot AI requested a review from ashleyshaw May 20, 2026 14:39
@ashleyshaw
Copy link
Copy Markdown
Member

@copilot I created a github issue here - #13

You created a pull request but never did anything - #336

I want you to proceed the #21 issue and working in the #333 PR, how do I get you to do that?

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 20, 2026

@copilot I created a github issue here - #13

You created a pull request but never did anything - #336...

To direct me to a specific issue and PR, here are the two best options:

To continue work on issue #21 inside PR #333:
Go to PR #333 and leave a comment like @copilot please work on issue #21 in this PR (or simply describe what you want done). The Copilot coding agent responds to comments mentioning @copilot on open PRs.

To start fresh on issue #21 with a new PR:
Go to issue #21 and click "Start working with Copilot" (the Copilot button), or leave a comment on the issue mentioning @copilot with the task description. This will create a new PR automatically.

Note: PR #333 is currently scoped to the CONTRIBUTING.md audit, not issue #21 (the a11y/security checklist task). If you want both in the same PR, just clarify that in a comment on #333 and I'll pick it up there.

@ashleyshaw
Copy link
Copy Markdown
Member

@copilot is there anything else you can do on this issue? - #13

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 20, 2026

@copilot is there anything else you can do on this issue? - #13

Issue #13 (migrate CI scripts from bash to JavaScript) is a significant engineering task that's out of scope for this documentation PR.

The dedicated PR for it is #336. To get me working on it, go to PR #336 and leave a comment like @copilot please implement the changes described in issue #13 — I'll pick up the task from there and start making the actual code changes.

Alternatively, you can close PR #336 and comment on issue #13 itself with @copilot to have me create a fresh PR scoped to that work.

@ashleyshaw
Copy link
Copy Markdown
Member

@copilot have you committed these files

Copy link
Copy Markdown
Contributor Author

Copilot AI commented May 20, 2026

@copilot have you committed these files

Yes — all four files were committed in commit 5dc42db:

  • .github/instructions/plugin-structure.instructions.md — added
  • CLAUDE.md — added
  • AGENTS.md — updated with CLAUDE.md cross-reference
  • Copilot-Processing.md — removed from repo root

The PR branch copilot/restart-work-on-instructions is pushed and ready for review.

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.

2 participants