Skip to content

docs: add AGENTS.md contributor guide for AI agents#369

Open
ethanndickson wants to merge 3 commits into
ethan/ai-provider-resourcefrom
docs/add-agents-md
Open

docs: add AGENTS.md contributor guide for AI agents#369
ethanndickson wants to merge 3 commits into
ethan/ai-provider-resourcefrom
docs/add-agents-md

Conversation

@ethanndickson

Copy link
Copy Markdown
Member

Adds an AGENTS.md contributor guide at the repo root to give AI coding agents the high-signal context they need to work in this provider safely.

The document captures the provider's framework idioms (terraform-plugin-framework, not SDKv2), the resource file layout, essential make commands, and — most importantly — the project-specific patterns and anti-patterns distilled from past fixes (e.g. handling unknown values at plan/validate time, refreshing cached entitlements after a license apply, not stripping cty sensitivity marks in plan modifiers, and avoiding defer inside retry loops). Each anti-pattern references the PR/issue it was learned from.

Contents were verified against the current tree: Makefile targets, the util.go helpers, provider.go entitlement plumbing, the CI Terraform 1.01.9 acceptance matrix, and the golangci paralleltest config.

@ethanndickson ethanndickson self-assigned this Jun 23, 2026
@ethanndickson ethanndickson changed the base branch from main to graphite-base/369 June 24, 2026 05:12
@ethanndickson ethanndickson changed the base branch from graphite-base/369 to ethan/ai-provider-resource June 24, 2026 05:12

ethanndickson commented Jun 24, 2026

Copy link
Copy Markdown
Member Author

Warning

This pull request is not mergeable via GitHub because a downstack PR is open. Once all requirements are satisfied, merge this PR as a stack on Graphite.
Learn more

This stack of pull requests is managed by Graphite. Learn more about stacking.

@ethanndickson ethanndickson force-pushed the docs/add-agents-md branch 4 times, most recently from f77324f to 2ec71e9 Compare June 24, 2026 07:56
@ethanndickson ethanndickson force-pushed the ethan/ai-provider-resource branch from d51dad0 to b1d81a3 Compare June 24, 2026 08:10
@ethanndickson ethanndickson force-pushed the ethan/ai-provider-resource branch from b1d81a3 to 6221b88 Compare June 24, 2026 12:32
@ethanndickson ethanndickson force-pushed the docs/add-agents-md branch 2 times, most recently from d7a0e3f to 3db900a Compare June 24, 2026 13:21
@ethanndickson ethanndickson force-pushed the ethan/ai-provider-resource branch 3 times, most recently from 839989b to 0d0e3b8 Compare June 24, 2026 14:42
@ethanndickson ethanndickson force-pushed the docs/add-agents-md branch 2 times, most recently from faaed66 to ce7bd51 Compare June 24, 2026 15:08
@ethanndickson ethanndickson force-pushed the ethan/ai-provider-resource branch from 0d0e3b8 to de42560 Compare June 24, 2026 15:08
@ethanndickson ethanndickson force-pushed the ethan/ai-provider-resource branch from de42560 to 2e2abe6 Compare June 24, 2026 15:15
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant