Skip to content

Add storage-specific AGENTS.md for sdk/storage subtree#49714

Draft
amnguye with Copilot wants to merge 2 commits into
mainfrom
copilot/create-agents-md-file
Draft

Add storage-specific AGENTS.md for sdk/storage subtree#49714
amnguye with Copilot wants to merge 2 commits into
mainfrom
copilot/create-agents-md-file

Conversation

Copilot AI commented Jul 2, 2026

Copy link
Copy Markdown
Contributor

Adds sdk/storage/AGENTS.md to give AI agents (Copilot Coding Agent, etc.) storage-specific context that is too narrow for the root AGENTS.md.

What's in the file

  • Module table — maps each azure-storage-* module to its Azure service
  • 4 agent rules:
    • Do not edit generated code in implementation/ or models/ paths — fix upstream in TypeSpec/OpenAPI
    • Preserve API consistency (parameter names, types, option bag names, return types) across Blob, Queue, File, and Data Lake clients
    • Prefer existing patterns (RequestRetryOptions, ParallelTransferOptions, PagedIterable/PagedFlux, Reactor async) over new abstractions
    • No magic strings — use HttpHeaderName, service-specific *Constants classes, and *ServiceVersion enums
  • Storage service semantics — per-service behavioral notes (AppendBlob overwrite safety, BlockBlob commit flow, Queue visibility timeout, File share hierarchy)
  • Build/test commands — including Azurite startup and live-test invocation

Co-authored-by: amnguye <48961492+amnguye@users.noreply.github.com>
Copilot AI changed the title [WIP] Add AGENTS.md for Azure Storage SDK guidance Add storage-specific AGENTS.md for sdk/storage subtree Jul 2, 2026
Copilot AI requested a review from amnguye July 2, 2026 23:10
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.

2 participants