Skip to content

feat: add agents, claude MD and update readme#2639

Merged
laurelfulford merged 5 commits intotrunkfrom
feat/add-agents-md
Feb 24, 2026
Merged

feat: add agents, claude MD and update readme#2639
laurelfulford merged 5 commits intotrunkfrom
feat/add-agents-md

Conversation

@laurelfulford
Copy link
Contributor

@laurelfulford laurelfulford commented Feb 24, 2026

All Submissions:

Changes proposed in this Pull Request:

This PR adds an AGENTS.md and CLAUDE.md to provide AI coding agents with repo-specific guidance.

It also updates the README.md file with information that agents can glean from the theme's file structure and code, but humans may not as easily.

The CLAUDE.md simply references AGENTS.md, matching the pattern used in the parent workspace.

Closes: NPPD-1253

How to test the changes in this Pull Request:

  1. Review AGENTS.md for accuracy against the codebase.
  2. Review the updates to README.md for accuracy against the codebase.
  3. Confirm CLAUDE.md contains only @AGENTS.md.

Other information:

  • Have you added an explanation of what your changes do and why you'd like us to include them?
  • Have you written new tests for your changes, as applicable?
  • Have you successfully ran tests with your changes locally?

@laurelfulford laurelfulford marked this pull request as ready for review February 24, 2026 20:01
@laurelfulford laurelfulford requested a review from a team as a code owner February 24, 2026 20:01
@laurelfulford laurelfulford added the [Status] Needs Review The issue or pull request needs to be reviewed label Feb 24, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR adds AI agent-specific documentation to help AI coding assistants understand the newspack-theme repository structure, conventions, and common gotchas. It includes a new AGENTS.md file with repository-specific guidance, a CLAUDE.md file that references the AGENTS.md, and enhancements to README.md that provide detailed structural information about the theme's PHP files, SCSS organization, and child theme architecture.

Changes:

  • Added AGENTS.md with repository-specific guidelines covering theme structure, build tooling, PHP architecture, and common development pitfalls
  • Added CLAUDE.md that references AGENTS.md, following parent workspace pattern
  • Enhanced README.md with detailed sections on repository structure, PHP file organization, SCSS directory layout, and child theme architecture

Reviewed changes

Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.

File Description
AGENTS.md New file providing AI agents with newspack-theme-specific guidelines including repository layout quirks, build tooling details, and common gotchas to avoid
CLAUDE.md New file that references AGENTS.md, matching the pattern used in the parent workspace
README.md Enhanced with detailed structural documentation including PHP file purposes, SCSS directory organization, and child theme architecture diagrams

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@github-actions github-actions bot added [Status] Approved The pull request has been reviewed and is ready to merge and removed [Status] Needs Review The issue or pull request needs to be reviewed labels Feb 24, 2026
@laurelfulford
Copy link
Contributor Author

Thanks @rbcorrales! I made the couple tweaks Copilot suggested since they made sense; they seemed pretty low-risk (one word in the Agents, and a couple in the Readme) so I'm going to go ahead and merge 🙂

@laurelfulford laurelfulford merged commit 8920552 into trunk Feb 24, 2026
9 checks passed
@laurelfulford laurelfulford deleted the feat/add-agents-md branch February 24, 2026 21:28
@github-actions
Copy link

Hey @laurelfulford, good job getting this PR merged! 🎉

Now, the needs-changelog label has been added to it.

Please check if this PR needs to be included in the "Upcoming Changes" and "Release Notes" doc. If it doesn't, simply remove the label.

If it does, please add an entry to our shared document, with screenshots and testing instructions if applicable, then remove the label.

Thank you! ❤️

matticbot pushed a commit that referenced this pull request Mar 5, 2026
# [2.19.0-alpha.1](v2.18.3...v2.19.0-alpha.1) (2026-03-05)

### Bug Fixes

* fix watch for scss build ([#2640](#2640)) ([88d50af](88d50af))
* follow Copilot suggestion to wrap in double quotes and escape same in font names too ([71af6d5](71af6d5))
* force array output to ensure window.newspackFontLoading() doesn't emit unexpected JS objects ([68614c4](68614c4))
* quote font names ([2585e72](2585e72))
* quote font names ([b6ab9f9](b6ab9f9))
* remove unnecessary character class, capture group; suggested by Claude ([5e44728](5e44728))

### Features

* add agents, claude MD and update readme ([#2639](#2639)) ([8920552](8920552))
@github-actions
Copy link

github-actions bot commented Mar 5, 2026

🎉 This PR is included in version 2.19.0-alpha.1 🎉

The release is available on GitHub release

Your semantic-release bot 📦🚀

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

Labels

released on @alpha [Status] Approved The pull request has been reviewed and is ready to merge

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants