docs: add AGENTS.md and CLAUDE.md for AI agent guidance#14862
Open
bobbor wants to merge 1 commit into
Open
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.
Description of changes
Adds
AGENTS.mdandCLAUDE.mdat the repo root to give AI coding agents the project conventions they need to make correct changes.AGENTS.md— repository/monorepo structure, environment versions, mandatoryyarn-only build/test/lint commands, testing conventions (mock underlying modules, notAmplify.getConfig; bundle-size scope), code conventions (license headers, no committedtsconfig.tsbuildinfo), Husky git hooks (pre-commit+pre-push/git-secrets), changeset requirements, branch naming, commit/PR flow, the 8 CI checks, and a Do/Don't summary.CLAUDE.md— thin pointer toAGENTS.mdso there is a single source of truth.All content was verified against the repo (root/package
package.jsonscripts,.github/workflows/pr.yml,.husky/,.changeset/).Issue #, if available
N/A
Description of how you validated changes
Docs-only change. Verified every cited command/script and CI check exists in the repo before committing.
Checklist
yarn testpasses (N/A — docs-only, no source changes)By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.