Skip to content

Add CLAUDE.md and AGENTS.md for AI-assisted development guidance#3580

Open
varadarajan-tw wants to merge 2 commits intomainfrom
add-claude-documentation
Open

Add CLAUDE.md and AGENTS.md for AI-assisted development guidance#3580
varadarajan-tw wants to merge 2 commits intomainfrom
add-claude-documentation

Conversation

@varadarajan-tw
Copy link
Contributor

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

  • Added unit tests for new functionality
  • Tested end-to-end using the local server
  • [If destination is already live] Tested for backward compatibility of destination. Note: New required fields are a breaking change.
  • [Segmenters] Tested in the staging environment
  • [Segmenters] [If applicable for this change] Tested for regression with Hadron.

Security Review

Please ensure sensitive data is properly protected in your integration.

  • Reviewed all field definitions for sensitive data (API keys, tokens, passwords, client secrets) and confirmed they use type: 'password'

New Destination Checklist

  • Extracted all action API versions to verioning-info.ts file. example

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>
Copy link
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

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
Copy link

Copilot AI Feb 11, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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.

Copilot uses AI. Check for mistakes.
@varadarajan-tw varadarajan-tw marked this pull request as ready for review February 20, 2026 10:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants

Comments