Add comprehensive AI agent guidelines for Claude, Cursor, and GitHub Copilot

[Copilot]

AI Agent Guidelines Implementation

• Analyze existing repository structure and conventions
• Review existing .ai/guidelines.md file
• Create .claude/CLAUDE.md with instructions to reference .ai/guidelines.md
• Create .cursorrules file with Cursor-specific instructions
• Create .github/copilot-instructions.md for GitHub Copilot
• Ensure all files follow self-maintaining principle
• Refactor to avoid duplication and focus on high-level context
• Clarify that middleware/adapters belong in separate repos

Summary

Successfully created comprehensive AI agent guidelines for Faraday repository with clear separation of concerns:

Latest Updates (addressing feedback):

• Removed duplicate content: Agent-specific files now provide high-level context only
• Clarified middleware/adapter policy: Made explicit that new middleware and adapters should be separate gems, NOT added to base repo
• Improved focus: Files now point to .ai/guidelines.md for all implementation details
• Reduced file sizes: Removed 144 lines of duplicated content across the three files

Files Created:

1. .claude/CLAUDE.md (30 lines) - High-level Claude-specific context
2. .cursorrules (29 lines) - Cursor rules with policy clarifications
3. .github/copilot-instructions.md (48 lines) - Copilot instructions with critical context

All files emphasize:

• Reading .ai/guidelines.md as the primary reference
• Creating middleware/adapters as separate gems
• Self-maintaining responsibility
• Faraday-specific (not generic) guidance

Original prompt

Problem Statement

Implement comprehensive, self-maintaining AI agent guidelines for the Faraday repository. These guidelines must ensure that all popular AI agents (Copilot, Claude, Cursor, etc.):

• Read and follow Faraday-specific conventions, including middleware/adapter patterns, code organization, testing, and documentation norms.
• Are responsible for suggesting updates as conventions evolve.

Implementation requirements:

• Create a new branch (e.g., ai-agent-guidelines).
• Add a .ai/guidelines.md file with Faraday-specific code style, middleware, adapter, and testing conventions (as previously drafted).
• Add .claude/CLAUDE.md, .cursorrules, and .github/copilot-instructions.md with clear instructions to reference .ai/guidelines.md and follow the self-maintaining principle.
• Ensure all files are focused on Faraday conventions and not generic Ruby/RSpec knowledge.
• Do NOT push directly to main/master—open a pull request for review.

Background:
Faraday is a Ruby HTTP client library with a middleware-based architecture. The repo uses custom middleware patterns, adapters, and RSpec testing. These guidelines should ensure all AI agents contribute code consistent with established project practices.

*This pull request was created as a result of the following prompt from Copilot chat.* > ## Problem Statement > > Implement comprehensive, self-maintaining AI agent guidelines for the Faraday repository. These guidelines must ensure that all popular AI agents (Copilot, Claude, Cursor, etc.): > - Read and follow Faraday-specific conventions, including middleware/adapter patterns, code organization, testing, and documentation norms. > - Are responsible for suggesting updates as conventions evolve. > > **Implementation requirements:** > - Create a new branch (e.g., `ai-agent-guidelines`). > - Add a `.ai/guidelines.md` file with Faraday-specific code style, middleware, adapter, and testing conventions (as previously drafted). > - Add `.claude/CLAUDE.md`, `.cursorrules`, and `.github/copilot-instructions.md` with clear instructions to reference `.ai/guidelines.md` and follow the self-maintaining principle. > - Ensure all files are focused on Faraday conventions and not generic Ruby/RSpec knowledge. > - Do NOT push directly to main/master—open a pull request for review. > > **Background:** > Faraday is a Ruby HTTP client library with a middleware-based architecture. The repo uses custom middleware patterns, adapters, and RSpec testing. These guidelines should ensure all AI agents contribute code consistent with established project practices.

---

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

[iMacTia]

@copilot I noticed some guidelines were repeated in these files from the shared .ai/guidelines file. Please avoid that and simply use these files to provide high-level context and a pointer to the shared guidelines.

Implementation details and their rules should be left for the actual guidelines file

[Copilot]

@copilot I noticed some guidelines were repeated in these files from the shared .ai/guidelines file. Please avoid that and simply use these files to provide high-level context and a pointer to the sha...

Refactored all three files to remove duplicate content. They now provide high-level context only and defer to .ai/guidelines.md for all implementation details. Reduced total line count from 251 to 107 lines. Commit: ddf651f → (new commit)

[iMacTia]

It's a good start! Let's take it for a ride and see how it goes 😄