feat: add agents, claude MD and update readme#2639
Conversation
There was a problem hiding this comment.
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.
|
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 🙂 |
|
Hey @laurelfulford, good job getting this PR merged! 🎉 Now, the 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! ❤️ |
# [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))
|
🎉 This PR is included in version 2.19.0-alpha.1 🎉 The release is available on GitHub release Your semantic-release bot 📦🚀 |
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:
Other information: