Skip to content

Split AGENTS.md so it holds for any copy of the theme - #214

Open
MaggieCabrera wants to merge 1 commit into
trunkfrom
update/split-agents-md
Open

MaggieCabrera wants to merge 1 commit into
trunkfrom
update/split-agents-md

Conversation

@MaggieCabrera

Copy link
Copy Markdown
Contributor

Description

Part of #75. AGENTS.md now covers the theme itself, so it can ship with the copy in WordPress core, like DESIGN.md does. That way it helps agents editing Ipsum or building on it anywhere, not only in this repository.

  • The dev environment notes, the pre-commit details and the pull request instructions move to CONTRIBUTING.md. AGENTS.md points there for work in this repository.
  • Links into CONTRIBUTING.md are full GitHub URLs, so they work from a copy that doesn't have it.
  • DESIGN.md now links to AGENTS.md for working on the theme's files.

Testing Instructions

  1. Read AGENTS.md as if you only had the theme's files. Nothing in it should depend on this repository's tooling.
  2. Check that what left AGENTS.md is in CONTRIBUTING.md: the dev environment, the pre-commit hook fallback, Version: staying at 1.0 and the pull request instructions.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 5.5
Used for: Splitting the file, moving the repository-only parts and this description.

🤖 Generated with Claude Code

AGENTS.md now covers the theme itself, so it can ship with the copy in WordPress core like DESIGN.md. The dev environment notes, the pre-commit details and the pull request instructions move to CONTRIBUTING.md, which AGENTS.md points to for work in this repository.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 9, 2026
@github-actions

github-actions Bot commented Nov 9, 2026 •

Copy link
Copy Markdown

The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs.

If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message.

Co-authored-by: MaggieCabrera <onemaggie@git.wordpress.org>
Co-authored-by: juanfra <juanfra@git.wordpress.org>

To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook.


Props Bot commands

You can trigger Props Bot actions by commenting on this PR:

  • @propsbot add <username> to give props to a GitHub user. Requires write access.
  • @propsbot remove <username> to leave a user out of the props. Requires write access.
  • @propsbot refresh to refresh this list. Adding the props-bot label works too.

@juanfra juanfra left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks @MaggieCabrera! Small nit

Comment thread CONTRIBUTING.md

When a change affects the front end or the Site Editor, test both and note what you checked in your pull request.

Only the theme ships with WordPress. Repository tooling and docs, such as `.github/`, `.husky/`, `bin/`, `CONTRIBUTING.md`, `README.md`, `package.json`, `.wp-env.json` and `.nvmrc`, stay in this repository. `AGENTS.md` and `DESIGN.md` ship with the theme, so keep them true for any copy of it.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: One thing I noticed is that we have .nvmrc, package.json and package-lock.json in core already (https://github.com/WordPress/wordpress-develop/tree/trunk/src/wp-content/themes/ipsum).

I read in the sync PR description that's for the default's theme workflow. Should we update this?

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

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants