Repository navigation
Add AGENTS.md - #34
Merged
Merged
Conversation
|
The following accounts have interacted with this PR and/or linked issues. I will continue to update these lists as activity occurs. You can also manually ask me to refresh this list by adding the If you're merging code through a pull request on GitHub, copy and paste the following into the bottom of the merge commit message. To understand the WordPress project's expectations around crediting contributors, please review the Contributor Attribution page in the Core Handbook. |
github-actions
Bot
added
the
documentation
Every agent session otherwise starts from zero and re-derives the same rules about this repository. This documents the layout, the conventions that are easy to get wrong, and the things that must not be touched. The pattern is described as the source of truth, since templates and parts are one-line delegates to it and page-sidebar.html is the exception that does not delegate. Also covered: the generic theme-1…theme-6 palette slugs that every style variation redefines, Gutenberg's flush-left block markup, the frozen 1.0.0 version, and the couplings that break silently — the comments CTA block binding, the two places sidebar templates are registered, the editor stylesheet mirror, and the .github assets that are linked by URL. Co-authored-by: CommandCodeBot <noreply@commandcode.ai>
Point agents at CONTRIBUTING.md for setup and pattern guidelines, keep only what is specific to this tree, and state each convention as the way to do it. Co-Authored-By: Claude Opus 5 <noreply@anthropic.com>
MaggieCabrera
force-pushed
the
add/agents-md
branch
from
September 21, 2026 11:12
9e2a3a4 to
4f4a954
Compare
Contributor
|
I rebased and updated this. Thanks for the contribution |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Adds
AGENTS.md, so a coding agent session does not start by re-deriving the same rules about this repository. It covers where the markup lives, the conventions the theme follows, what must not be touched, and the couplings that break silently.It is written from the tree rather than from general WordPress practice, and every path, slug and glob in it was checked against the repository.
What it documents
.github/is repository tooling and never part of the theme.templates/*.htmlandparts/*.htmlare one-line delegates, so editing a template changes nothing at render time. Its two exceptions are called out:templates/page-sidebar.htmlholds its own markup and does not delegate, andparts/header.htmldelegates toipsum/header-default.ipsumtext domain and the existing i18n spacing, the generictheme-1…theme-6slugs that each color variation redefines (so a literal hex freezes one palette into every other), the pattern header keys for insertable patterns versus template replacements, tabs and thefunction_existsguard in PHP, and the prose "why" comments kept instyle.cssandassets/css/editor-style.css.1.0.0version and the absent changelog entries, the deliberateRequires at least: 7.1placeholder, the.githubdemo content, blueprint and screenshots that are linked by URL, the@mobile/@tabletbreakpoint keys, and--wp--custom--control-scheme, which is a fallback a color variation cannot set.One thing left out
The issue suggests linking
CONTRIBUTING.md. It is not in the tree yet, and pull requests #2 and #16 each add one, so a link here would be dead until one of those lands — and would point at whichever version wins. A follow-up line is easy to add afterwards.Fixes #4
AI disclosure: This code was aided and/or researched using AI. Deepseek Flash through Command Code harness. I take full responsibility for it's contents.