diff --git a/AGENTS.md b/AGENTS.md index 42ac3ed2..5623f13c 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -28,6 +28,8 @@ bun test main.test.ts # Run single TS test (from - Use semantic versioning; bump version via script when modifying modules - Docker tests require Linux or Colima/OrbStack (not Docker Desktop) - Use `tf` (not `hcl`) for code blocks in README; use relative icon paths (e.g., `../../../../.icons/`) +- **Do NOT include input/output variable tables in module or template READMEs.** The registry automatically generates these from the Terraform source (e.g., variable and output blocks in `main.tf`). Adding them to the README is redundant and creates maintenance drift. +- Usage examples (e.g., a `module "..." { }` block) are encouraged, but not tables enumerating inputs/outputs. ## PR Review Checklist