Add agent guides & claude file#815
Merged
agibson-godaddy merged 9 commits intomasterfrom Mar 31, 2026
Merged
Conversation
Contributor
There was a problem hiding this comment.
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.mdwith repo build/test/linting/architecture guidance. - Introduced
.agents/guides/with a common setup guide and a detailed abilities implementation guide. - Added
.gitattributestoexport-ignoreagent/docs/tests/build artifacts fromgit 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.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
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.
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.mdfile..gitattributesis also committed to exclude these files from composer, along with some other items that are not meaningful to end plugins.QA
And to confirm gitattributes:
ls -la vendor/skyverge/wc-plugin-frameworkCLAUDE.mdnot present.agents/directory not presentBefore merge