Skip to content

docs: add AGENTS.md and CLAUDE.md for AI agent guidance#14862

Open
bobbor wants to merge 1 commit into
mainfrom
phandpau/docs/agents-md
Open

docs: add AGENTS.md and CLAUDE.md for AI agent guidance#14862
bobbor wants to merge 1 commit into
mainfrom
phandpau/docs/agents-md

Conversation

@bobbor

@bobbor bobbor commented Jul 6, 2026

Copy link
Copy Markdown
Member

Description of changes

Adds AGENTS.md and CLAUDE.md at the repo root to give AI coding agents the project conventions they need to make correct changes.

  • AGENTS.md — repository/monorepo structure, environment versions, mandatory yarn-only build/test/lint commands, testing conventions (mock underlying modules, not Amplify.getConfig; bundle-size scope), code conventions (license headers, no committed tsconfig.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 to AGENTS.md so there is a single source of truth.

All content was verified against the repo (root/package package.json scripts, .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

  • PR description included
  • yarn test passes (N/A — docs-only, no source changes)
  • Unit Tests are changed or added (N/A — docs-only)
  • Relevant documentation is changed or added

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@bobbor bobbor requested a review from a team as a code owner July 6, 2026 12:17
@changeset-bot

changeset-bot Bot commented Jul 6, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: 2a8f7c2

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

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