Skip to content

chore(agents): add agent config, ADRs, and reviewer docs - #186

Merged
schultzp2020 merged 2 commits into
mainfrom
chore/agents-config
Nov 3, 2026
Merged

schultzp2020 merged 2 commits into
mainfrom
chore/agents-config

Conversation

@schultzp2020

Copy link
Copy Markdown
Contributor

Summary

Extends this repo's agent configuration onto the same standard as the existing AGENTS.md + .agents/skills/ surface, and records the architectural decisions behind the repo's current shape as ADRs.

 root
-├── AGENTS.md           # contributor pointers only
+├── AGENTS.md           # + Agent skills section (tracker, triage labels, domain docs)
+├── CONTEXT.md          # high-level orientation + knowledge index
+├── REVIEW.md           # what failure looks like here, for AI reviewers
+├── .agents/skills/     # unchanged (codemod, backstage-codemod-issue-research, validate-codemod-recipe)
 └── docs/
-    (no docs directory)
+    ├── agents/
+    │   ├── issue-tracker.md, triage-labels.md, domain.md   # config
+    └── adr/            # 0001–0005

Which issue(s) does this PR fix

None — agentic repo hygiene. All five ADRs were verified against the commit history (no decisions superseded; every cited commit exists on main).

Evidence

  • Before: AGENTS.md pointed at CONTRIBUTING.md and the .agents/skills/; there was no issue-tracker/triage-label/domain config for agent skills, no orientation doc, no reviewer contract, and no record of why the repo looks the way it does.
  • After: docs/agents/ carries the per-repo agent-skill config (GitHub Issues on this repo, default five-label triage vocabulary, single-context domain docs — the five labels now exist on the tracker); CONTEXT.md orients a fresh agent; REVIEW.md lists this repo's release-blocking and cross-platform failure modes; ADRs 0001–0005 document the Yarn 4/oxfmt toolchain, the flattened one-recipe-per-release layout, AST-first codemods with AI fixup fallback, the convention-based test runner in packages/scripts, and release-owned README/version generation.

Testing

Config, docs, and skill files only — no runtime code changed. yarn format, yarn lint, yarn test, and yarn check:changed (the same gate CI runs) all pass on this branch.

Merge Danger

Door: two-way

Blast Radius: developer tooling

Nothing is removed and no workflow changes — anyone not using agent tooling is unaffected. Agent harnesses that already read AGENTS.md get one new pointer section.

How to revert

git revert <commit> — no data or generated artifacts depend on the new layout.

How to test changes / Special notes for the reviewer

Review order suggestion: AGENTS.md (the pointers) → CONTEXT.md + docs/agents/ (the layout) → REVIEW.md (reviewer contract) → docs/adr/ (records only, no behavior). ADRs cite commits by short hash; spot-check a few with git show <hash>. No changeset: docs-only, no codemod changed.

- Add docs/agents/ (issue tracker, triage labels, domain docs) following
  the setup-matt-pocock-skills conventions; add an Agent skills section
  to AGENTS.md
- Add CONTEXT.md (orientation + knowledge index) and REVIEW.md (what
  failure looks like here, for AI reviewers)
- Record five ADRs from the commit history: Yarn 4/oxfmt toolchain,
  flattened recipe layout, AST-first codemods with AI fixup fallback,
  convention-based test runner, release-owned README/version generation
- Create the five triage labels on the GitHub tracker

Config and docs only — no runtime code changed.
- ADR-0001: recipe-local tsconfigs and newer recipes' own typescript
  devDependency, instead of the categorical shared-config claim
- ADR-0003: attribute the d12b8fc/8b709dc/38f173a fixes to tightening
  AST receiver/type scoping, not to AI-step false positives
- REVIEW.md: check:changed runs CI's changed-file gate; CI additionally
  runs yarn test:scripts and a Changeset Check job
@schultzp2020
schultzp2020 merged commit ae61aba into main Nov 3, 2026
2 checks passed
@schultzp2020
schultzp2020 deleted the chore/agents-config branch November 3, 2026 17:03
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