Skip to content

chore: add AGENTS.md for AI coding assistants #664

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bnusunny merged 1 commit into from
Mar 18, 2026
Merged

chore: add AGENTS.md for AI coding assistants #664

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
# AGENTS.md

## Build & Test

- Build: `cargo build`
- Run all tests: `cargo nextest run`
- Run a single test: `cargo nextest run <test_name>`
- Lint: `cargo clippy --all-targets`
- Docs: `cargo doc --no-deps`

## Project Structure

- `src/lib.rs` — Core adapter logic, public API (`Adapter`, `AdapterOptions`, `Protocol`, `LambdaInvokeMode`)
- `src/main.rs` — Binary entrypoint
- `src/readiness.rs` — Readiness check checkpoint timing
- `tests/integ_tests/` — Integration tests
- `tests/e2e_tests/` — End-to-end tests (marked `#[ignore]`, require external setup)

## Key Conventions

- Environment variables use `AWS_LWA_` prefix
- Tests that mutate env vars rely on nextest's per-test process isolation
Loading