Skip to content

Commit b6f0fc9

Browse files
authored
chore: add AGENTS.md for AI coding assistants (#664)
1 parent d5cd422 commit b6f0fc9

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,22 @@
1+
# AGENTS.md
2+
3+
## Build & Test
4+
5+
- Build: `cargo build`
6+
- Run all tests: `cargo nextest run`
7+
- Run a single test: `cargo nextest run <test_name>`
8+
- Lint: `cargo clippy --all-targets`
9+
- Docs: `cargo doc --no-deps`
10+
11+
## Project Structure
12+
13+
- `src/lib.rs` — Core adapter logic, public API (`Adapter`, `AdapterOptions`, `Protocol`, `LambdaInvokeMode`)
14+
- `src/main.rs` — Binary entrypoint
15+
- `src/readiness.rs` — Readiness check checkpoint timing
16+
- `tests/integ_tests/` — Integration tests
17+
- `tests/e2e_tests/` — End-to-end tests (marked `#[ignore]`, require external setup)
18+
19+
## Key Conventions
20+
21+
- Environment variables use `AWS_LWA_` prefix
22+
- Tests that mutate env vars rely on nextest's per-test process isolation

0 commit comments

Comments
 (0)