Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly
Appearance settings

Add AGENTS.md file to align with AGENTS.md standards #53118

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Draft
wants to merge 4 commits into
base: main
Choose a base branch
Loading
from
Draft

Add AGENTS.md file to align with AGENTS.md standards #53118

wants to merge 4 commits into from

Conversation

Copilot
Copy link
Contributor

@Copilot Copilot AI commented Oct 9, 2025 •
edited
Loading

  • Review existing .github/copilot-instructions.md and relevant repository documentation
  • Create AGENTS.md file at repository root following AGENTS.md standards
  • Include repository purpose, scope, and key workflows
  • Document automation boundaries and agent interaction guidelines
  • Add cross-reference between AGENTS.md and .github/copilot-instructions.md
  • Include SDK-specific automation workflows (codegen, API review, test matrix)
  • Add reference in README.md for better discoverability
  • Validate the file structure and content
  • Fix all relative links to use absolute URL format per Azure SDK guidelines
Original prompt

This section details on the original issue you should resolve

<issue_title>Add AGENTS.md file</issue_title>
<issue_description># 🧩 Add AGENTS.md file to align with AGENTS.md standards

📄 Description

This repository currently includes a .github/copilot-instructions.md file, but it does not yet have an AGENTS.md file to describe how AI agents (e.g., Copilot, MCP, or LLM-based assistants) should interact with this repository.

To align with emerging AGENTS.md standards and ensure consistent developer experiences across Azure SDK repositories, we should add a top-level AGENTS.md file that defines:

  • Repository purpose and scope
  • Key workflows, commands, and automation boundaries for agents
  • Supported contribution actions (e.g., PR triage, labeling, issue summarization)
  • Guidance for safe and effective agent interactions with CI/CD pipelines, SDK tests, and documentation

✅ Proposed Tasks

  • Review existing .github/copilot-instructions.md and identify relevant guidance to merge or reference in AGENTS.md.
  • Create an AGENTS.md file at the root of the repository following the canonical structure defined at AGENTS.md.
  • Cross-link between .github/copilot-instructions.md and AGENTS.md for discoverability.
  • (Optional) Add repository metadata in AGENTS.md to describe SDK-specific automation workflows (e.g., codegen, API review, test matrix).

📘 Example References

🧭 Context

This issue is part of a broader initiative to introduce AGENTS.md across all Azure SDK repositories (see the Azure SDK org overview) to standardize AI agent documentation and improve consistency in automation and Copilot-based contributions.
</issue_description>

Comments on the Issue (you are @copilot in this section)

Fixes #53117

✨ Let Copilot coding agent set things up for you — coding agent works faster and does higher quality work when set up for your repo.

@Copilot @ronniegeraghty
Add AGENTS.md file with comprehensive AI agent guidelines
d1e4bcd 
Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>
@Copilot Copilot AI changed the title [WIP] Add AGENTS.md file to align with standards Add AGENTS.md file to align with AGENTS.md standards Oct 9, 2025
@Copilot Copilot AI requested a review from ronniegeraghty October 9, 2025 18:31
Copilot finished work on behalf of ronniegeraghty October 9, 2025 18:31
@ronniegeraghty
Copy link
Member

@copilot
Link has invalid format ../AGENTS.md
DO NOT use relative link ../AGENTS.md. Please use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links

@Copilot Copilot SWE Agent
Copy link
Contributor Author

Copilot AI commented Oct 9, 2025

@copilot
Link has invalid format ../AGENTS.md
DO NOT use relative link ../AGENTS.md. Please use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links
...

Fixed in commit d1e4bcd. Changed the relative link ../AGENTS.md to absolute URL format: https://github.com/Azure/azure-sdk-for-net/blob/main/AGENTS.md

@Copilot @ronniegeraghty
Fix relative link to use absolute URL format in copilot-instructions.md
8e9644b 
Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>
Copilot finished work on behalf of ronniegeraghty October 9, 2025 19:46
@ronniegeraghty
Copy link
Member

@copilot, fix these other invalid links
##[warning]Link has invalid format CONTRIBUTING.md
##[warning]DO NOT use relative link CONTRIBUTING.md. Please use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links
##[warning]Link has invalid format eng/common/instructions/azsdk-tools/
##[warning]DO NOT use relative link eng/common/instructions/azsdk-tools/. Please use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links
##[warning]broken link CONTRIBUTING.md
##[warning]Link has invalid format README.md
##[warning]DO NOT use relative link README.md. Please use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links
##[warning]Link has invalid format doc/dev/Versioning.md
##[warning]DO NOT use relative link doc/dev/Versioning.md. Please use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links
##[warning]Link has invalid format .github/copilot-instructions.md
##[warning]DO NOT use relative link .github/copilot-instructions.md. Please use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links
##[warning]Link has invalid format LICENSE.txt
##[warning]DO NOT use relative link LICENSE.txt. Please use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links

@Copilot @ronniegeraghty
Convert all relative links to absolute URLs in AGENTS.md
d6eee60 
Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>
@Copilot Copilot SWE Agent
Copy link
Contributor Author

Copilot AI commented Oct 10, 2025

@copilot, fix these other invalid links
##[warning]Link has invalid format CONTRIBUTING.md
##[warning]DO NOT use relative link CONTRIBUTING.md. Please use absolute link instead. Check here for more ...

Fixed in commit 8e9644b. All relative links converted to absolute URLs:

Copilot finished work on behalf of ronniegeraghty October 10, 2025 17:46
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@ronniegeraghty ronniegeraghty Awaiting requested review from ronniegeraghty ronniegeraghty is a code owner

@jsquire jsquire Awaiting requested review from jsquire jsquire will be requested when the pull request is marked ready for review jsquire is a code owner

At least 1 approving review is required to merge this pull request.

Assignees

@ronniegeraghty ronniegeraghty

Copilot code review Copilot

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Add AGENTS.md file

2 participants

@Copilot @ronniegeraghty
Morty Proxy This is a proxified and sanitized view of the page, visit original site.