Skip to content

AGENTS.md

Latest commit

 

History

History
54 lines (37 loc) · 2.73 KB

AGENTS.md

File metadata and controls

54 lines (37 loc) · 2.73 KB

Agent Guidelines — ydb-rs-sdk

Canonical agent entry point. Tool configs (CLAUDE.md, Cursor rules) start here and route to .agents/.

Keep this file lean (~60 lines) — it routes to detailed sources. Loading a large AGENTS.md on every session wastes context tokens; use a thin navigation file plus on-demand docs (see agentsmd/agents.md).

Project context

Project knowledge lives in .agents/context/. Coding rules live in .agents/rules/ (below). See .agents/README.md for the full layout.

Before coding — read selectively:

  1. One stable file as needed:
  2. Quick lookup: README.md, CONTRIBUTING.md, docs.rs/ydb

After significant work — update progress.md and stable context files when the work itself merges. Do not merge changes to activeContext.md (branch-only scratch pad — see file header).

On "update memory bank" — review all core files in .agents/context/README.md.

Coding rules (load on demand)

Topic File
Style, API boundaries, dependencies .agents/rules/coding-standards.md
Unit vs integration tests, local YDB .agents/rules/testing.md
Issue-first workflow, user boundaries .agents/rules/workflow.md
Local dev, docker-compose, CI commands .agents/rules/environment.md

Non-obvious rules (always on)

  • Comments, doc comments, error messages, logs: English.
  • Match style in the touched module; do not reformat unrelated code.
  • Do not change Cargo.toml / Cargo.lock unless the task requires it.
  • Integration tests are #[ignore]; need YDB_CONNECTION_STRING and --include-ignored.
  • ydb-grpc is generated; clippy excludes it. Do not bump crate versions unless asked.
  • Non-trivial changes: discuss in a GitHub issue first (CONTRIBUTING.md).

Done when

From repo root:

cargo fmt --check
cargo clippy --workspace --all-targets --no-deps --exclude=ydb-grpc -- -D warnings
cargo test --workspace

Also: update progress.md only when the delivered work merges.

Ask the user before dependency upgrades, MSRV changes, or public API design choices.