Skip to content

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

Merged
MaggieCabrera merged 3 commits into
trunkfrom
update/split-agents-md
Nov 12, 2026
Merged

MaggieCabrera merged 3 commits 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 Outdated

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?

MaggieCabrera and others added 2 commits November 12, 2026 16:18
#215)

* Move the pattern guidelines into DESIGN.md so they ship with the theme

CONTRIBUTING.md stays in this repository, which is archived once Ipsum reaches 1.0, so the rules for writing a pattern move to a Writing patterns section in DESIGN.md, tidied but complete. CONTRIBUTING.md and AGENTS.md now point there.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>

* Update DESIGN.md

Co-authored-by: Juanfra Aldasoro <juanfraa@gmail.com>

---------

Co-authored-by: Claude Opus 5.5 <noreply@anthropic.com>
Co-authored-by: Juanfra Aldasoro <juanfraa@gmail.com>
Co-authored-by: MaggieCabrera <onemaggie@git.wordpress.org>
Co-authored-by: juanfra <juanfra@git.wordpress.org>
Core's copy of Ipsum has its own build-only package.json, package-lock.json and .nvmrc, like the other bundled themes, so CONTRIBUTING.md no longer lists them as files that only live in this repository.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
@MaggieCabrera
MaggieCabrera merged commit 634fda7 into trunk Nov 12, 2026
5 checks passed
@MaggieCabrera
MaggieCabrera deleted the update/split-agents-md branch November 12, 2026 15:22
MaggieCabrera added a commit to MaggieCabrera/wordpress-develop that referenced this pull request Nov 12, 2026
`AGENTS.md` now covers the theme itself, so it ships with the theme, like `DESIGN.md`, and helps agents that edit Ipsum or build on it anywhere. What only applies to the GitHub repository stays there, in `CONTRIBUTING.md`, and `DESIGN.md` links to `AGENTS.md` for working on the theme's files.

Synced from WordPress/ipsum#214.

See #66678.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
MaggieCabrera added a commit to MaggieCabrera/wordpress-develop that referenced this pull request Nov 12, 2026
`AGENTS.md` now covers the theme itself, so it ships with the theme, like `DESIGN.md`, and helps agents that edit Ipsum or build on it anywhere. What only applies to the GitHub repository stays there, in `CONTRIBUTING.md`, and `DESIGN.md` links to `AGENTS.md` for working on the theme's files.

Synced from WordPress/ipsum#214.

See #66678.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
wporg-sync pushed a commit to WordPress/wordpress-develop that referenced this pull request Nov 17, 2026
This updates Ipsum from `bc2e5af700e28980f251d97f58cf80c72ee50a13` to `d26734ecc1ba178d9c120178ce9d2c48825fc108` on its `trunk` branch.

A full list of changes included in this commit can be found on GitHub: WordPress/ipsum@bc2e5af...d26734e

- Address the review notes from the 7.2 Beta 5 core commit (WordPress/ipsum#216)
- Fix Pullquote custom line height not applying on the front end (WordPress/ipsum#203)
- Fix horizontal scroll caused by long unbroken words in comments (WordPress/ipsum#200)
- Improve design guide defaults and schema descriptions (WordPress/ipsum#193)
- Make the short post date format translatable (WordPress/ipsum#224)
- Fix Details block markers being announced by screen readers (WordPress/ipsum#230)
- Remove the physical left alignment from the page patterns (WordPress/ipsum#226)
- Indent the navigation submenus on the inline start (WordPress/ipsum#225)
- Fix accessible names for overlay navigation (WordPress/ipsum#228)
- Split AGENTS.md so it holds for any copy of the theme (WordPress/ipsum#214)
- Use a logical margin for the comment form checkbox (WordPress/ipsum#231)
- Keep keyboard focus visible and clear of the sticky header (WordPress/ipsum#145)
- Fix accessible name of overlay search form (WordPress/ipsum#239)
- Show a message when the blog and Archive Full have no posts (WordPress/ipsum#238)
- Keep the post date on one line when categories wrap (WordPress/ipsum#205)
- Remove repeated button styles from theme.json (WordPress/ipsum#235)
- Remove unused values from theme.json (WordPress/ipsum#237)
- Make the credit line URL translatable (WordPress/ipsum#240)
- Use single border radius values in theme.json (WordPress/ipsum#236)
- Escape the short post date format instead of ignoring PHPCS (WordPress/ipsum#245)
- Use the Site Title in Footer Centered (WordPress/ipsum#244)
- Keep AGENTS.md about the theme, not the GitHub repository (WordPress/ipsum#247)
- Treat "Written by" as a label before the author name (WordPress/ipsum#246)
- Use Quote blocks for statement patterns and remove text quote mark styles (WordPress/ipsum#232)
  

This commit also includes changes that only exist in core:

- Tests for the `ipsum/get-design-guide` ability are added in `tests/phpunit/tests/theme/ipsumGetDesignGuideAbility.php`, because Ipsum's repository has no PHPUnit setup. On multisite, the tests save global styles as a super admin, since only super admins can save unfiltered global styles.
- `contributing.txt` says Ipsum is developed on GitHub until its 1.0 release, with contributions going through Trac after that. It also drops the note about `style.css` being used when it is newer than `style.min.css`.
- A test message in `ipsumDesignGuide.php` says "do not match" instead of "to not match".

Developed in: #15948

Follow-up to r65366.

Props onemaggie, juanfra, shailu25, iamarinoh, 369work, gziolo, wildworks, suryakantupadhyay, khushalsains, ravipatel, meahadi.
Fixes #66678. See #66352.

git-svn-id: https://develop.svn.wordpress.org/trunk@65549 602fd350-edb4-49c9-b593-d223f7449a82
wporg-sync pushed a commit to WordPress/WordPress that referenced this pull request Nov 17, 2026
This updates Ipsum from `bc2e5af700e28980f251d97f58cf80c72ee50a13` to `d26734ecc1ba178d9c120178ce9d2c48825fc108` on its `trunk` branch.

A full list of changes included in this commit can be found on GitHub: WordPress/ipsum@bc2e5af...d26734e

- Address the review notes from the 7.2 Beta 5 core commit (WordPress/ipsum#216)
- Fix Pullquote custom line height not applying on the front end (WordPress/ipsum#203)
- Fix horizontal scroll caused by long unbroken words in comments (WordPress/ipsum#200)
- Improve design guide defaults and schema descriptions (WordPress/ipsum#193)
- Make the short post date format translatable (WordPress/ipsum#224)
- Fix Details block markers being announced by screen readers (WordPress/ipsum#230)
- Remove the physical left alignment from the page patterns (WordPress/ipsum#226)
- Indent the navigation submenus on the inline start (WordPress/ipsum#225)
- Fix accessible names for overlay navigation (WordPress/ipsum#228)
- Split AGENTS.md so it holds for any copy of the theme (WordPress/ipsum#214)
- Use a logical margin for the comment form checkbox (WordPress/ipsum#231)
- Keep keyboard focus visible and clear of the sticky header (WordPress/ipsum#145)
- Fix accessible name of overlay search form (WordPress/ipsum#239)
- Show a message when the blog and Archive Full have no posts (WordPress/ipsum#238)
- Keep the post date on one line when categories wrap (WordPress/ipsum#205)
- Remove repeated button styles from theme.json (WordPress/ipsum#235)
- Remove unused values from theme.json (WordPress/ipsum#237)
- Make the credit line URL translatable (WordPress/ipsum#240)
- Use single border radius values in theme.json (WordPress/ipsum#236)
- Escape the short post date format instead of ignoring PHPCS (WordPress/ipsum#245)
- Use the Site Title in Footer Centered (WordPress/ipsum#244)
- Keep AGENTS.md about the theme, not the GitHub repository (WordPress/ipsum#247)
- Treat "Written by" as a label before the author name (WordPress/ipsum#246)
- Use Quote blocks for statement patterns and remove text quote mark styles (WordPress/ipsum#232)
  

This commit also includes changes that only exist in core:

- Tests for the `ipsum/get-design-guide` ability are added in `tests/phpunit/tests/theme/ipsumGetDesignGuideAbility.php`, because Ipsum's repository has no PHPUnit setup. On multisite, the tests save global styles as a super admin, since only super admins can save unfiltered global styles.
- `contributing.txt` says Ipsum is developed on GitHub until its 1.0 release, with contributions going through Trac after that. It also drops the note about `style.css` being used when it is newer than `style.min.css`.
- A test message in `ipsumDesignGuide.php` says "do not match" instead of "to not match".

Developed in: WordPress/wordpress-develop#15948

Follow-up to r65366.

Props onemaggie, juanfra, shailu25, iamarinoh, 369work, gziolo, wildworks, suryakantupadhyay, khushalsains, ravipatel, meahadi.
Fixes #66678. See #66352.
Built from https://develop.svn.wordpress.org/trunk@65549


git-svn-id: http://core.svn.wordpress.org/trunk@64622 1a063a9b-81f0-0310-95a4-ce76da25c4cd
arshidkv12 pushed a commit to arshidkv12/wordpress-develop that referenced this pull request Nov 21, 2026
This updates Ipsum from `bc2e5af700e28980f251d97f58cf80c72ee50a13` to `d26734ecc1ba178d9c120178ce9d2c48825fc108` on its `trunk` branch.

A full list of changes included in this commit can be found on GitHub: WordPress/ipsum@bc2e5af...d26734e

- Address the review notes from the 7.2 Beta 5 core commit (WordPress/ipsum#216)
- Fix Pullquote custom line height not applying on the front end (WordPress/ipsum#203)
- Fix horizontal scroll caused by long unbroken words in comments (WordPress/ipsum#200)
- Improve design guide defaults and schema descriptions (WordPress/ipsum#193)
- Make the short post date format translatable (WordPress/ipsum#224)
- Fix Details block markers being announced by screen readers (WordPress/ipsum#230)
- Remove the physical left alignment from the page patterns (WordPress/ipsum#226)
- Indent the navigation submenus on the inline start (WordPress/ipsum#225)
- Fix accessible names for overlay navigation (WordPress/ipsum#228)
- Split AGENTS.md so it holds for any copy of the theme (WordPress/ipsum#214)
- Use a logical margin for the comment form checkbox (WordPress/ipsum#231)
- Keep keyboard focus visible and clear of the sticky header (WordPress/ipsum#145)
- Fix accessible name of overlay search form (WordPress/ipsum#239)
- Show a message when the blog and Archive Full have no posts (WordPress/ipsum#238)
- Keep the post date on one line when categories wrap (WordPress/ipsum#205)
- Remove repeated button styles from theme.json (WordPress/ipsum#235)
- Remove unused values from theme.json (WordPress/ipsum#237)
- Make the credit line URL translatable (WordPress/ipsum#240)
- Use single border radius values in theme.json (WordPress/ipsum#236)
- Escape the short post date format instead of ignoring PHPCS (WordPress/ipsum#245)
- Use the Site Title in Footer Centered (WordPress/ipsum#244)
- Keep AGENTS.md about the theme, not the GitHub repository (WordPress/ipsum#247)
- Treat "Written by" as a label before the author name (WordPress/ipsum#246)
- Use Quote blocks for statement patterns and remove text quote mark styles (WordPress/ipsum#232)
  

This commit also includes changes that only exist in core:

- Tests for the `ipsum/get-design-guide` ability are added in `tests/phpunit/tests/theme/ipsumGetDesignGuideAbility.php`, because Ipsum's repository has no PHPUnit setup. On multisite, the tests save global styles as a super admin, since only super admins can save unfiltered global styles.
- `contributing.txt` says Ipsum is developed on GitHub until its 1.0 release, with contributions going through Trac after that. It also drops the note about `style.css` being used when it is newer than `style.min.css`.
- A test message in `ipsumDesignGuide.php` says "do not match" instead of "to not match".

Developed in: WordPress#15948

Follow-up to r65366.

Props onemaggie, juanfra, shailu25, iamarinoh, 369work, gziolo, wildworks, suryakantupadhyay, khushalsains, ravipatel, meahadi.
Fixes #66678. See #66352.

git-svn-id: https://develop.svn.wordpress.org/trunk@65549 602fd350-edb4-49c9-b593-d223f7449a82
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