Skip to content

docs(agents): fix broken Rust bullet and stale crate list #527

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

Open
hyeonggyu wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(agents): fix broken Rust bullet and stale crate list #527

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
6 changes: 4 additions & 2 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,8 @@ crates/protocol/ # provider-neutral protocol types
crates/switchyard-server/ # native HTTP server and TOML config
crates/switchyard-translation/ # wire-format codecs
crates/switchyard-py/ # libsy and server PyO3 bindings
crates/switchyard-skill-distillation/ # skill-distillation records and port traits
crates/switchyard-soak/ # release-candidate soak tester

tests/ # Unit tests (pytest)
```
Expand Down Expand Up @@ -236,8 +238,8 @@ cargo test --workspace
- **Type hints**: throughout. `py.typed` marker present; mypy runs strict.
- **Async**: async-only. If you need sync, use `asyncio.run()`.
- **Testing**: `respx` for HTTP mocking, `pytest-mock` for general mocking. `asyncio_mode = "auto"` — no `@pytest.mark.asyncio` needed.
- **Rust**: Panicking calls such as `panic!()`, `unwrap()` and `.except()` are not allowed in production source code. Propagate errors with `?`. They are allowed in tests.
return typed errors, or match explicitly in tests so failures stay intentional and visible.
- **Rust**: Panicking calls such as `panic!()`, `unwrap()`, and `.expect()` are not allowed in production source code (they are allowed in tests).
Propagate errors with `?` — return typed errors, or match explicitly in tests so failures stay intentional and visible.
- **Comments**: For Rust changes, add concise comments for module/file intent, public structs/enums,
public methods, private helpers with non-obvious behavior, and tests that encode important
behavior. Prefer one-line comments when enough. Add block comments before complex validation,
Expand Down