Skip to content

Move the pattern guidelines into DESIGN.md so they ship with the theme - #215

Merged
MaggieCabrera merged 2 commits into
update/split-agents-mdfrom
update/pattern-guidelines-in-design
Nov 12, 2026
Merged

MaggieCabrera merged 2 commits into
update/split-agents-mdfrom
update/pattern-guidelines-in-design

Conversation

@MaggieCabrera

Copy link
Copy Markdown
Contributor

Description

Part of #75. Stacked on #214, so merge that first.

The rules for writing a pattern move from CONTRIBUTING.md to a new Writing patterns section at the end of DESIGN.md, so they ship with the theme. CONTRIBUTING.md stays in this repository, which gets archived once Ipsum reaches 1.0, but anyone adding patterns to Ipsum or a child theme still needs these rules.

  • Every rule and example comes over, tidied: repeated and half-finished sentences are gone, and each rule is said once.
  • CONTRIBUTING.md keeps the Pattern creation guidelines heading as a pointer, so existing links still land somewhere.
  • AGENTS.md sends agents adding or changing a pattern to the new section.

Testing Instructions

  1. Read the old Pattern creation guidelines on trunk next to Writing patterns in DESIGN.md. Every rule and example is still there.
  2. Check that the links from AGENTS.md, CONTRIBUTING.md and the top of DESIGN.md land on the section.

Use of AI Tools

AI assistance: Yes
Tool(s): Claude Code
Model(s): Claude Opus 5.5
Used for: Moving and tidying the guidelines, checking nothing was lost, and this description.

🤖 Generated with Claude Code

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>
@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.

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Nov 9, 2026
@MaggieCabrera
MaggieCabrera requested a review from juanfra November 9, 2026 15:03

@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.

LGTM, thanks!

Comment thread DESIGN.md Resolved
Co-authored-by: Juanfra Aldasoro <juanfraa@gmail.com>
@MaggieCabrera
MaggieCabrera merged commit 2531b76 into update/split-agents-md Nov 12, 2026
5 checks passed
@MaggieCabrera
MaggieCabrera deleted the update/pattern-guidelines-in-design branch November 12, 2026 15:18
MaggieCabrera added a commit that referenced this pull request Nov 12, 2026
* Split AGENTS.md so it holds for any copy of the theme

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>

* Move the pattern guidelines into DESIGN.md so they ship with the theme (#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>

* Say that core keeps its own package.json, package-lock.json and .nvmrc

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>

---------

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>
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