Skip to content

Commit 769f95d

Browse files
committed
docs(agents): add folder descriptions under Project Structure
Expand sources/Valkey.Glide subfolder list with concise purpose descriptions to guide agents. Signed-off-by: Joey Brinkman <jbrinkman@microsoft.com> Signed-off-by: jbrinkman <joe.brinkman@improving.com>
1 parent 80ec7f7 commit 769f95d

File tree

1 file changed

+7
-2
lines changed

1 file changed

+7
-2
lines changed

AGENTS.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,6 @@ This document gives AI agents the minimum, accurate context needed to work produ
1313
- Public APIs are async; cancellation is supported.
1414
- Rust core (glide-core) accessed via P/Invoke; be careful with marshaling.
1515
- Commands organized via partials in `BaseClient.*.cs`; cluster features use routing (`Route`, `ClusterValue<T>`).
16-
- Compatibility layer under `Abstract/`, command interfaces in `Commands/`, internals under `Internals/`, batching under `Pipeline/`.
1716

1817
## Build and Test Rules (Agents)
1918

@@ -140,7 +139,13 @@ Note: Conventional Commits apply to commit messages only. Do not enforce this fo
140139
- `BaseClient.cs` and partials: `BaseClient.*.cs` for commands (String, Hash, List, Set, SortedSet, Generic)
141140
- `GlideClient.cs`, `GlideClusterClient.cs`
142141
- `ConnectionConfiguration.cs` (builders), `GlideString.cs` (encoding), `ClusterValue.cs`, `Route.cs`, `Logger.cs`, `Errors.cs`
143-
- Folders: `Abstract/`, `abstract_APITypes/`, `abstract_Enums/`, `Commands/`, `Internals/`, `Pipeline/`
142+
- Folders:
143+
- `Abstract/` – base abstractions for clients, pipelines, and shared contracts
144+
- `abstract_APITypes/` – public API types (value objects/DTOs) exposed to consumers
145+
- `abstract_Enums/` – public enums used across the API surface and routing
146+
- `Commands/` – shared command helpers (argument builders, key routing helpers, common utilities)
147+
- `Internals/` – interop and low-level glue (P/Invoke to Rust core, marshaling, buffers, utilities)
148+
- `Pipeline/` – batching/pipelining primitives and request/response grouping
144149
- `tests/`
145150
- `Valkey.Glide.UnitTests/` – unit-level validation, parsing, API construction
146151
- `Valkey.Glide.IntegrationTests/` – end-to-end standalone and cluster tests, batching, AZ Affinity, error handling

0 commit comments

Comments
 (0)