docs: add AGENTS.md for AI coding agents guidance and remove CLAUDE.md - #14
Closed
akalipetis wants to merge 2 commits into
Closed
docs: add AGENTS.md for AI coding agents guidance and remove CLAUDE.md#14akalipetis wants to merge 2 commits into
akalipetis wants to merge 2 commits into
Conversation
Also, update README.md to point to AGENTS.md for development and prerequisites for building and testing
Contributor
There was a problem hiding this comment.
Pull request overview
This PR modernizes the AI agent guidance by replacing the Claude-specific CLAUDE.md with a more general AGENTS.md that supports multiple AI coding assistants (GitHub Copilot, Claude, Cursor, etc.). It also enhances the README with a new Development section that provides prerequisites for building and testing.
Key Changes
- Replaced
CLAUDE.mdwith a more comprehensiveAGENTS.mdthat provides guidance for all AI coding agents - Added a Development section to
README.mdwith build/test prerequisites and commands - Expanded documentation structure in
AGENTS.mdwith more detailed architecture descriptions, code patterns, and integration test guidance
Reviewed changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| README.md | Added Development section with prerequisites and command references, pointing to AGENTS.md for AI agent guidance |
| CLAUDE.md | Removed Claude-specific guidance file (168 lines deleted) |
| AGENTS.md | Added comprehensive AI agent guidance covering both Go and PHP CLI, architecture, patterns, and common issues (529 lines added) |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
Contributor
Author
|
Closing this one, since it's drifted and has conflicts. |
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.
Also, update README.md to point to AGENTS.md for development and prerequisites for building and testing