feat: add AGENTS.md #393
feat: add AGENTS.md #393
Conversation
- Create comprehensive AGENTS.md with project structure and development commands - Add symlinks for CLAUDE.md and .github/copilot-instructions.md - Include testing requirements, architecture details, and workflow notes - Enable consistent AI assistance across Claude Code and GitHub Copilot 🤖 Generated with [Claude Code](https://claude.ai/code) Co-Authored-By: Claude <noreply@anthropic.com>
There was a problem hiding this comment.
Pull Request Overview
This PR adds comprehensive documentation for AI coding assistants working with the Coder Registry repository. The documentation provides structured guidance on project organization, development workflows, and testing requirements.
Key changes:
- Creates AGENTS.md with detailed project overview and development guidelines
- Adds reference files (CLAUDE.md and .github/copilot-instructions.md) that point to the main documentation
- Establishes standardized documentation for AI assistant interactions
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| AGENTS.md | Main documentation file containing project overview, development commands, testing workflows, and architectural guidance |
| CLAUDE.md | Reference file pointing to AGENTS.md for Claude AI assistant |
| .github/copilot-instructions.md | Reference file pointing to AGENTS.md for GitHub Copilot |
Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.
|
|
||
| ```bash | ||
| # Test all modules with .tftest.hcl files | ||
| ./scripts/terraform_test_all.sh |
There was a problem hiding this comment.
| ./scripts/terraform_test_all.sh | |
| bun run test |
Should we do bun run test instead since it essentially is the same thing?
|
|
||
| ### Module Testing | ||
|
|
||
| - Every module MUST have `.tftest.hcl` test files |
There was a problem hiding this comment.
Would it be worth going over typescript tests as well here, or are we wanting to omit this since this is just selective instruction for AI when working on the registry?
There was a problem hiding this comment.
Feel free to make them as complete as possible. They are exclusively for AI.
Summary
Test plan
🤖 Generated with Claude Code