Skip to content

docs: update AGENTS.md to match CI and current project layout - #932

Open
bnusunny wants to merge 1 commit into
mainfrom
docs/update-agents-md
Open

bnusunny wants to merge 1 commit into
mainfrom
docs/update-agents-md

Conversation

@bnusunny

@bnusunny bnusunny commented Nov 14, 2026 •

Copy link
Copy Markdown
Contributor

Summary

  • Align lint/format commands with CI (cargo clippy --all-targets -- -Dwarnings, cargo fmt --all -- --check) so local checks catch what pr.yaml rejects
  • Correct the src/readiness.rs description; add src/snapstart.rs and benches/
  • Note the lib target is internal (publish = false), not a stable public API
  • Document deprecated unprefixed env var fallbacks (PORT remains supported), nextest's retries = 3, e2e env requirements, and the commitlint conventions
  • Point to Makefile / docs/development.md for cargo lambda release builds

Test plan

  • cargo clippy --all-targets -- -Dwarnings passes
  • cargo fmt --all -- --check passes

- Align lint/format commands with CI (clippy -Dwarnings, fmt --check)
- Fix readiness.rs description; add snapstart.rs and benches/
- Note lib target is internal (publish = false)
- Document deprecated unprefixed env vars, nextest retries, e2e env requirements, and commit message conventions
@bnusunny
bnusunny requested a review from a team as a code owner November 14, 2026 19:34

This branch has not been deployed

No deployments
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