chore: add AGENTS.md and CLAUDE.md#1887
Open
sai-ray 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.
This PR:
AGENTS.mdat the repo root: an agent-facing repository guide auto-discovered by Codex CLI, Copilot, Cursor, Claude Code, Kiro, and other coding tools.CLAUDE.md: a one-line@AGENTS.mdimport so Claude Code picks up the same content deterministically.Why
AI coding agents working on this repo today have no auto-discoverable entry point. Agents either skim
CONTRIBUTING.md(human-oriented prose) or operate without project-specific guidance, leading to inconsistent behavior across tools (jsii incompatibilities, edits to projen-generated files,missing
alarmNames, snapshot drift mistakes).AGENTS.mdis the cross-tool industry standard (governed by the Linux Foundation's Agentic AI Foundation; ~60K repos as of March 2026). The same pattern is being adopted inaws/aws-cdkand across the cdklabs org.What
AGENTS.md(~270 lines) — quick reference, codebase non-obvious locations (withlib/and projen-generated siblings flagged "NEVER edit"), role & principles, architecture, MUST/SHOULD/MAY design rules (jsii, projen, file naming, tests, alarms, build hygiene), decision logic for commonbranching choices (Lambda vs ECS vs shared, alarm severity, public type placement, integ test scope,
AlarmSeveritiesvsalarmOverrides), implementation patterns, contribution process, key references.CLAUDE.md(1 line) —@AGENTS.mdimport.CONTRIBUTING.md,README.md,docs/application-overview.md,.projenrc.ts, and the conventions already enforced insrc/. No new rules are introduced.By submitting this pull request, I confirm that my contribution is made under the terms of the Apache-2.0 license