chore: add CLAUDE.md files#2809
Merged
opieter-aws merged 1 commit intoJun 15, 2026
Merged
Conversation
notowen333
approved these changes
Jun 15, 2026
Contributor
|
Assessment: Comment (no blocking issues) Small, well-scoped, and the description does an excellent job explaining the why. I verified every claim against the tree and they hold up. The only thing genuinely needing a decision is the Review Categories
Nicely reasoned change — the zero-duplication "import sibling AGENTS.md" approach is the right call. |
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.
Description
Two unrelated-looking but mutually reinforcing gaps in our agent guidance, fixed together because they share a root cause: the rules agents rely on either weren't stated clearly or weren't reliably loaded.
Sharpened naming conventions.
strands-py/AGENTS.mdonly said "Private members: Prefix with_". Read literally, "members" suggests class attributes, and the adjacent "Variables/Functions" line covers casing only — so an agent had no explicit instruction that private functions and modules take a leading underscore. It now reads "Private members, functions, and modules" with examples. On the TypeScript side,@internalis already used in ~70 places across the SDK to mark exported-but-non-public symbols, yetstrands-ts/AGENTS.mdnever mentioned it; the TSDoc section now documents the convention so agents apply it consistently instead of inferring it from surrounding code.Reliable AGENTS.md loading. The harness auto-loads
CLAUDE.mdfrom the repo root and any subdirectory it touches, but it does not reliably auto-load nestedAGENTS.md. Our per-package guides were therefore only entering context via a soft, monorepo-ambiguous nudge ("go read the repo's AGENTS.md"). This adds a one-lineCLAUDE.md(@AGENTS.md) at the root and in each package that has anAGENTS.md(strands-py,strands-ts,site,test-infra). Each file just imports its siblingAGENTS.md, so the correct package guide loads automatically based on which subtree is being edited, with zero content duplication —AGENTS.mdremains the single source of truth.To make those import files trackable, this also removes the
CLAUDE.mdentries from.gitignore,site/.gitignore, andstrands-py/.gitignore.Note
CLAUDE.mdwas previously gitignored on purpose. Un-ignoring it is a deliberate reversal: it means these import stubs are shared with everyone, and any contributor's previously-ignored localCLAUDE.mdwill now surface as untracked. Flagging for explicit sign-off rather than slipping it in.Related Issues
Documentation PR
No
site/documentation changes. The edits are to agent-facing guidance files (AGENTS.md), not the published docs site.Type of Change
Documentation update
Testing
Documentation- and config-only change; no runtime behavior is affected.
git check-ignoreno longer matches anyCLAUDE.md, so the new import files are trackable.CLAUDE.mdcontains exactly@AGENTS.mdand sits beside an existingAGENTS.md.hatch run prepareChecklist
By submitting this pull request, I confirm that you can use, modify, copy, and redistribute this contribution, under the terms of your choice.