Skip to content

Add agent guides & claude file#815

Merged
agibson-godaddy merged 9 commits intomasterfrom
agent-guides
Mar 31, 2026
Merged

Add agent guides & claude file#815
agibson-godaddy merged 9 commits intomasterfrom
agent-guides

Conversation

@agibson-godaddy
Copy link
Copy Markdown
Contributor

@agibson-godaddy agibson-godaddy commented Mar 30, 2026

Summary

This creates a new .agents/guides/ directory, which is intended to serve as implementation guides for AI agents to follow. The first guide committed is for abilities implementation.

This also initializes a new CLAUDE.md file.

.gitattributes is also committed to exclude these files from composer, along with some other items that are not meaningful to end plugins.

QA

  • Docs review

And to confirm gitattributes:

  1. Upgrade to this branch in any plugin.
  2. Run ls -la vendor/skyverge/wc-plugin-framework
    • CLAUDE.md not present
    • .agents/ directory not present
  3. Load some WordPress pages with your chose plugin activated.
    • Everything still works as expected.

Before merge

  • I have confirmed these changes in each supported minor WooCommerce version

@agibson-godaddy agibson-godaddy self-assigned this Mar 30, 2026
@agibson-godaddy agibson-godaddy marked this pull request as ready for review March 30, 2026 12:09
@agibson-godaddy agibson-godaddy requested a review from Copilot March 30, 2026 12:09
Copy link
Copy Markdown
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

Adds AI-agent–oriented documentation and ensures those development-only docs (and other non-distribution assets) are excluded from Composer dist archives for consumer plugins.

Changes:

  • Added CLAUDE.md with repo build/test/linting/architecture guidance.
  • Introduced .agents/guides/ with a common setup guide and a detailed abilities implementation guide.
  • Added .gitattributes to export-ignore agent/docs/tests/build artifacts from git archive / Composer dist exports.

Reviewed changes

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

File Description
CLAUDE.md Repository-level guidance for Claude Code: build, tests, linting, architecture, and conventions.
.gitattributes Marks dev-only files/dirs (including .agents/ and CLAUDE.md) as export-ignore for Composer dist archives.
.agents/guides/COMMON-SETUP.md Shared discovery/setup steps and placeholder resolution used by implementation guides.
.agents/guides/ABILITIES-IMPLEMENTATION-GUIDE.md Step-by-step guide (with examples, tests, QA template) for adding Abilities API support to plugins.

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

Comment thread .agents/guides/ABILITIES-IMPLEMENTATION-GUIDE.md Outdated
Comment thread .agents/guides/ABILITIES-IMPLEMENTATION-GUIDE.md Outdated
Comment thread .agents/guides/ABILITIES-IMPLEMENTATION-GUIDE.md Outdated
Comment thread .agents/guides/ABILITIES-IMPLEMENTATION-GUIDE.md
agibson-godaddy and others added 3 commits March 30, 2026 13:16
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@agibson-godaddy agibson-godaddy merged commit b7a7cee into master Mar 31, 2026
5 checks passed
@agibson-godaddy agibson-godaddy deleted the agent-guides branch March 31, 2026 11:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants