Skip to content

Commit a111a6d

Browse files
committed
chore: add a simple AGENTS.md
This commit adds a simple AGENTS.md. This wasn't human-curated, just the output of opencode's `/init` with Opus 4.5.
1 parent 974a605 commit a111a6d

File tree

1 file changed

+20
-0
lines changed

1 file changed

+20
-0
lines changed

AGENTS.md

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
# AGENTS.md
2+
3+
## Build & Test Commands
4+
- Build: `cargo build`
5+
- Test all: `cargo test`
6+
- Test single: `cargo test <test_name>` or `cargo test --test <file> <test_name>`
7+
- Clippy: `cargo clippy --all-targets -- -D warnings -D unreachable_pub -D clippy::await_holding_lock -D clippy::clone_on_ref_ptr`
8+
- Format: `cargo fmt --all`
9+
- Lint fix: `./scripts/lint-fix.sh`
10+
- Feature check: `cargo hack check --feature-powerset --no-dev-deps --depth 1`
11+
12+
## Code Style
13+
- Rust 2021 edition, use `rustfmt` defaults
14+
- Imports: group std, external crates, then internal modules; use `crate::` for internal imports
15+
- Types: prefer `Box<dyn Error + Send + Sync>` for generic errors; use `anyhow::Result` for bootstrap errors
16+
- Naming: snake_case for functions/variables, PascalCase for types, SCREAMING_SNAKE for constants
17+
- Errors: use `BootstrapResult<T>` (anyhow) for initialization, `Result<T>` (boxed error) for runtime
18+
- Docs: add `///` doc comments for public items; `#![warn(missing_docs)]` is enabled
19+
- Feature flags: wrap platform/optional code with `#[cfg(feature = "...")]`
20+
- No `openssl`/`openssl-sys` - use `boring`, `ring`, or `rustls` instead

0 commit comments

Comments
 (0)