docs: add canonical AGENTS.md for the GitHub-as-code repo#59
Merged
Conversation
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
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.
Fixes #55.Problem
devantler-tech/.github— the org's GitHub-as-code source of truth (deploy/, Crossplane +provider-upjet-github, published as a cosign-signed OCI artifact and reconciled by the platform
github-configtenant) — had noAGENTS.md, so the daily engineer (and Copilot code review,Cursor, Codex, …) operate it with no canonical instructions and no
## Maintenancecard. Every otheractively-developed portfolio repo carries one.
What this does
Adds a canonical
AGENTS.md(96 lines) that:AGENTS.mdfor the sharedengineering contract; documents only what's repo-specific.
unwritten here: manage GitHub declaratively, never imperatively (the tenant reverts
gh api/UIdrift; applying an existing label is triage, editing a label definition is config); ownership →
the
maintainersteam, not individuals; Observe-first adoption (external-name + managementpolicy excluding
Delete); and thatIssueLabelsis authoritative (enumerate a repo's livelabels before applying, or it deletes undeclared ones).
deploy/layout (repositories/,teams/,labels/, provider-config,external-secret, kustomization).
## Maintenancecard: the exact validate command (kubectl kustomize deploy/, which iswhat
ci.yamlruns and the soleCI - Required Checksgate), the roadmap home (epic Roadmap: declarative GitHub-org-as-code — extend coverage & sustain the source of truth #56), and arepo-specific watch-list (drift/coverage, the
cd.yamlpublish path, agent-file freshness).Scope decisions (worth a reviewer's eye)
#55 listed three gaps; this PR addresses them as follows:
AGENTS.md— added (the core of this PR). ✅.github/copilot-instructions.md— intentionally not added. Per the root contract, we haveretired the separate Copilot-review instruction file org-wide — Copilot code review reads
AGENTS.mddirectly (since 2026-06-18), so a parallel file is redundant. The issue's premise here is now stale.
CONTRIBUTING.mddeploy/ guidance — intentionally not added to.github/CONTRIBUTING.md.That file is the org-wide default community-health file rendered for every repo in the org, so
deploy/-specific guidance does not belong there. The Crossplane authoring workflow now lives inAGENTS.md(the repo's canonical file) alongside the existing architecture notes indeploy/README.md. ✅ (intent covered, correct home)Validation
kubectl kustomize deploy/builds clean (theCI - Required Checksgate; unchanged by this docs-only diff).AGENTS.mdresolve to existing paths.Docs-only; no behaviour change. Opened as a draft for promotion.