Skip to content

chore: drop CLAUDE.md import stubs in favour of AGENTS.md - #119

Merged
neelay-aign merged 1 commit into
mainfrom
chore/drop-claude-md-stubs
Sep 21, 2026
Merged

neelay-aign merged 1 commit into
mainfrom
chore/drop-claude-md-stubs

Conversation

@neelay-aign

Copy link
Copy Markdown
Contributor

What & why

Claude Code reads AGENTS.md directly since v2.1.277, including nested AGENTS.md that load on demand when it opens a file in a subdirectory (docs). The one-line @AGENTS.md import stubs were a workaround for that gap and are no longer needed.

Removes the four stubs (repo root, .github/, tests/, src/aignostics_foundry_core/) and rewrites every remaining CLAUDE.md reference to AGENTS.md: headings, the cross-links between the nested guides, and the PR-review workflow prompt. Markdown and one workflow prompt string only — no code.

This mirrors aignostics/foundry-python#431, which does the same in the template this repo is generated from. Worth landing both so a later copier update is a no-op here rather than a conflict.

Caveats worth a look before merging

  • CLAUDE.local.md silently suppresses AGENTS.md. Per the docs, a CLAUDE.local.md counts as a project instruction file, so Claude reads only it and skips AGENTS.md entirely. Today the committed stub means such a developer still gets everything through the import; afterwards they get their local file and none of the project guidance. It is gitignored and per-developer, so this is invisible from the repo. Workaround: /configProject instructionsclaude-md-and-agents-md.
  • Bedrock / telemetry-disabled sessions can't read AGENTS.md and the docs recommend keeping a CLAUDE.md import there. Those environments, and any Claude Code older than v2.1.277, get zero project instructions once the stub is gone.

Both are the maintainers' call — flagging, not blocking.

Verification

  • mise run lint: 0 errors. mise run test_unit: 16 passed.
  • No CLAUDE.md reference remains anywhere in the repo (git grep returns nothing).
  • Every .md cross-link in all four AGENTS.md files resolves to a file that exists.

Unrelated pre-existing issue noticed

AGENTS.md:171 and AGENTS.md:175 link to CONTRIBUTING.md and RELEASE_WORKFLOW.md, neither of which exists in this repo — broken on main too. Left alone as out of scope.

🤖 Generated with Claude Code

Claude Code reads AGENTS.md directly (v2.1.277+), including nested
AGENTS.md loaded on demand when it opens files in a subdirectory, so the
one-line `@AGENTS.md` stubs are no longer needed.

Removes the four stubs and rewrites every remaining CLAUDE.md reference —
headings, cross-links and the PR-review workflow prompt — to AGENTS.md.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
@neelay-aign
neelay-aign requested a review from a team as a code owner September 21, 2026 09:44
@sonarqubecloud

Copy link
Copy Markdown

@codecov

codecov Bot commented Sep 21, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ All tests successful. No failed tests found.

@neelay-aign
neelay-aign merged commit f5e20b2 into main Sep 21, 2026
13 checks passed
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.

2 participants