Home Original page

docs: add AI coding agent guidelines by mdelapenya · Pull Request #3446 · testcontainers/testcontainers-go

@mdelapenya @claude 

Add comprehensive AI.md file to guide AI coding agents working on the
repository. This document combines best practices learned from module
development with practical workflow guidelines.

Key sections:
- Repository overview and structure
- Environment setup (Go version, gvm usage)
- Development workflow (testing, git, PRs)
- Module development best practices:
  - Container struct design (use Container, not module-specific names)
  - Run function pattern (5-step implementation)
  - Container options (when to use built-in vs custom)
  - State inspection with strings.CutPrefix
  - Variadic arguments usage
- Testing guidelines and common pitfalls
- Reference documentation pointers

This helps AI agents understand the codebase architecture, follow
established patterns, and avoid common mistakes.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

coderabbitai[bot]

Update AI.md with specific details from the conventions.yml GitHub workflow:
- Enforced commit types: security, fix, feat, docs, chore, deps
- Scope rules: optional, must be lowercase
- Subject rules: must not start with uppercase
- Breaking change notation with !
- PR title validation details
- Warning about main branch PRs being auto-closed

This ensures AI agents follow the exact conventions enforced by CI.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Replace lengthy module development examples with quick reference that
links to docs/modules/index.md for complete details. This:
- Avoids duplication between AI.md and existing documentation
- Keeps AI.md concise and scannable
- Ensures single source of truth for detailed patterns
- Provides just enough context for AI agents to get started

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Add 'text' language hint to the commit message example code fence
for proper syntax highlighting.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

coderabbitai[bot]

Include gvm commands for both Apple Silicon (arm64) and Intel/AMD
(amd64) architectures to support all users.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>
Add AI.md to the excluded_files list in changed-modules.sh to prevent
documentation-only changes from triggering unnecessary module builds.

🤖 Generated with [Claude Code](https://claude.com/claude-code)

Co-Authored-By: Claude <noreply@anthropic.com>

coderabbitai[bot]