Skip to content

[Storage] Add AGENTS.md guidance files for shared, blobs, datalake, and file shares#7205

Open
amnguye wants to merge 3 commits into
mainfrom
copilot/storage-agents-md-draft
Open

[Storage] Add AGENTS.md guidance files for shared, blobs, datalake, and file shares#7205
amnguye wants to merge 3 commits into
mainfrom
copilot/storage-agents-md-draft

Conversation

@amnguye

@amnguye amnguye commented Jul 8, 2026

Copy link
Copy Markdown
Member

Add AGENTS.md guidance files for shared, blobs, datalake, and file shares

Pull Request Checklist

Please leverage this checklist as a reminder to address commonly occurring feedback when submitting a pull request to make sure your PR can be reviewed quickly:

See the detailed list in the contributing guide.

  • C++ Guidelines
  • Doxygen docs
  • Unit tests
  • No unwanted commits/changes
  • Descriptive title/description
    • PR is single purpose
    • Related issue listed
  • Comments in source
  • No typos
  • Update changelog
  • Not work-in-progress
  • External references or docs updated
  • Self review of PR done
  • Any breaking changes?

Copilot AI review requested due to automatic review settings July 8, 2026 00:48
@github-actions github-actions Bot added the Storage Storage Service (Queues, Blobs, Files) label Jul 8, 2026

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

Adds Storage-area AGENTS.md guidance so AI agents working in sdk/storage and specific storage packages have package-relevant context (domain model, pitfalls, testing focus, and review triggers).

Changes:

  • Add a shared storage-scoped sdk/storage/AGENTS.md with cross-cutting Storage SDK guidance.
  • Add package-local AGENTS.md guidance for blobs and file shares.
  • Add a Data Lake guidance file (currently placed under sdk/storage/azure-storage-datalake).

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 3 comments.

File Description
sdk/storage/AGENTS.md Adds shared storage guidance and links to service-local guidance files.
sdk/storage/azure-storage-blobs/AGENTS.md Adds blob-domain client hierarchy, pitfalls, and review/testing triggers.
sdk/storage/azure-storage-datalake/AGENTS.md Adds Data Lake-specific guidance (but currently not located in the actual azure-storage-files-datalake package directory).
sdk/storage/azure-storage-files-shares/AGENTS.md Adds file shares domain model, pitfalls, and review/testing triggers.

Comment thread sdk/storage/AGENTS.md Outdated
Comment thread sdk/storage/AGENTS.md
Comment thread sdk/storage/azure-storage-files-datalake/AGENTS.md
- sdk/storage/AGENTS.md: change scope from sdk/storage/* to sdk/storage/** to cover nested package files
- sdk/storage/AGENTS.md: fix typo 'files shares' -> 'file shares'
- Move sdk/storage/azure-storage-datalake/AGENTS.md to sdk/storage/azure-storage-files-datalake/AGENTS.md to match the actual package directory
- Update scope and naming note in the relocated Data Lake AGENTS.md
- Update the reference in sdk/storage/AGENTS.md accordingly

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
@Jinming-Hu

Copy link
Copy Markdown
Member

@copilot review again

Replace curly right-single-quote (U+2019) with ASCII apostrophe in sdk/storage/AGENTS.md.

Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>

Copilot AI commented Jul 8, 2026

Copy link
Copy Markdown
Contributor

@copilot review again

All four AGENTS.md files look good. All previous review issues have been addressed in b142e91:

  • Scope glob is sdk/storage/** (covers nested files)
  • Typo corrected: "file shares"
  • Data Lake guidance is correctly placed at sdk/storage/azure-storage-files-datalake/AGENTS.md with matching scope
  • No stale azure-storage-datalake directory remains
  • All cross-references are consistent

@Jinming-Hu Jinming-Hu left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amnguye Thanks for the contribution! This gives agents a really useful map of storage libraries.

Copilot AI requested a review from Jinming-Hu July 8, 2026 01:38
@Jinming-Hu Jinming-Hu enabled auto-merge (squash) July 8, 2026 01:38
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Storage Storage Service (Queues, Blobs, Files)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants