Add CLAUDE.md and AGENTS.md for AI-assisted development guidance#3580
Add CLAUDE.md and AGENTS.md for AI-assisted development guidance#3580varadarajan-tw wants to merge 2 commits intomainfrom
Conversation
Document repository architecture, common commands, destination/action patterns, development workflows, and testing conventions to help Claude Code work effectively in this monorepo. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
Merge guidance from .github/copilot-instructions.md including error handling (custom error classes, retry behavior), implementation best practices (field definitions, batching, security, performance), testing guidelines, PR review guidelines, and expanded package descriptions with registration file paths. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com>
There was a problem hiding this comment.
Pull request overview
This pull request adds comprehensive AI-assisted development documentation to help Claude Code and other AI agents work effectively with the Action Destinations monorepo. The documentation provides detailed guidance on repository architecture, common commands, development workflows, testing patterns, and best practices.
Changes:
- Added CLAUDE.md with comprehensive repository documentation covering architecture, commands, patterns, and best practices
- Added AGENTS.md as a reference file to point AI tools to CLAUDE.md
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| CLAUDE.md | Comprehensive AI development guide covering repository structure, commands, architecture patterns, error handling, testing conventions, and PR guidelines |
| AGENTS.md | Reference pointer to CLAUDE.md for AI agent tools |
| @@ -0,0 +1 @@ | |||
| CLAUDE.md No newline at end of file | |||
There was a problem hiding this comment.
The AGENTS.md file appears to contain the full content of CLAUDE.md instead of just a reference to it. According to the diff, this file should only contain the text "CLAUDE.md" on line 1, which would serve as a pointer for AI tools. However, the actual file contains the entire CLAUDE.md documentation. This duplication creates a maintenance issue where both files would need to be updated for any changes.
| ### Core Packages | ||
|
|
||
| - **destination-actions** (`packages/destination-actions`): Cloud-mode destinations (~213 destinations). New destinations must be registered in `packages/destination-actions/src/index.ts`. | ||
| - **browser-destinations** (`packages/browser-destinations`): Device-mode (client-side) destinations. New destinations must be registered in `packages/destinations-manifest/index.ts`. |
There was a problem hiding this comment.
The file path for the browser destination registry is incorrect. The path should be packages/destinations-manifest/src/index.ts (note the /src/ directory), not packages/destinations-manifest/index.ts. This is where browser-mode destinations are registered.
| - **browser-destinations** (`packages/browser-destinations`): Device-mode (client-side) destinations. New destinations must be registered in `packages/destinations-manifest/index.ts`. | |
| - **browser-destinations** (`packages/browser-destinations`): Device-mode (client-side) destinations. New destinations must be registered in `packages/destinations-manifest/src/index.ts`. |
| - `packages/destination-actions/src/destinations/`: All cloud-mode destinations | ||
| - `packages/destination-actions/src/index.ts`: Cloud destination registry | ||
| - `packages/browser-destinations/destinations/`: All browser-mode destinations | ||
| - `packages/destinations-manifest/index.ts`: Browser destination registry |
There was a problem hiding this comment.
The file path for the browser destination registry is incorrect. The path should be packages/destinations-manifest/src/index.ts (note the /src/ directory), not packages/destinations-manifest/index.ts.
| - `packages/destinations-manifest/index.ts`: Browser destination registry | |
| - `packages/destinations-manifest/src/index.ts`: Browser destination registry |
Document repository architecture, common commands, destination/action patterns, development workflows, and testing conventions to help Claude Code work effectively in this monorepo.
Testing
N/A
Security Review
Please ensure sensitive data is properly protected in your integration.
type: 'password'New Destination Checklist
verioning-info.tsfile. example