docs: add AGENTS.md as canonical contributor + agent guide#297
Open
dcmcand wants to merge 1 commit into
Open
Conversation
Adds AGENTS.md at the repo root as the canonical, committed guide for human contributors and any AI coding agent (Claude Code, Codex, Cursor, Aider, etc.). Content audited against actual code: cluster + DNS provider categories, registry layout, real Provider interface methods, correct OTEL defaults, ADR-0004 as the direction-of-travel reference. Also fixes stale "Backed by OpenTofu" doc comments on Provider.Deploy and Provider.Destroy - those predate the Hetzner provider and read as if the interface mandates Tofu, which it does not. Closes #296
dcmcand
requested review from
Adam-D-Lewis,
aktech,
dharhas,
marcelovilla,
tylerpotts and
viniciusdc
as code owners
This was referenced May 13, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
AGENTS.mdat the repo root as the canonical, committed guide for human contributors and any AI coding agent (agents.md convention, picked up by Claude Code, Codex, Cursor, Aider, Jules, ...).CLAUDE.md. Notable corrections: cluster + DNS provider categories (not just cluster), realProviderinterface methods (GetKubeconfig/Summary, noStatus), correctOTEL_EXPORTERdefault (none), Hetzner useshetzner-k3s(not OpenTofu),InfraSettings.SupportsLocalGitOps, accuratepkg/layout includingdnsprovider,registry,helm,kubeconfig,git. Points readers at ADR-0004 for the direction-of-travel.Provider.Deploy/Provider.Destroy. The interface itself is tool-agnostic - Hetzner doesn't use Tofu - and the doc shouldn't claim otherwise.CLAUDE.mdstays gitignored. Developers who want Claude Code's pickup behavior can keep a local one-lineCLAUDE.mdpointing atAGENTS.md; the team source of truth is the committedAGENTS.md.Closes #296
Test plan
make lintpasses (ran via pre-commit hook)make test-unitpasses (ran via pre-commit hook)go vet/go fmtcleanAGENTS.mdfor any remaining inaccuracies they spot from lived knowledge of the codebaseProviderinterface doc change reads correctly