Add AGENTS.md file to align with AGENTS.md standards #25394
Conversation
Co-authored-by: ronniegeraghty <28957151+ronniegeraghty@users.noreply.github.com>
Copilot
AI
changed the title
There was a problem hiding this comment.
Pull Request Overview
This PR adds a comprehensive AGENTS.md file to align with emerging AGENTS.md standards and provide guidance for AI agents interacting with the Azure SDK for Go repository. The file establishes clear boundaries for AI agent interactions and provides detailed workflow guidance.
Key changes:
- Creates a comprehensive 236-line AGENTS.md file with repository overview, agent boundaries, workflows, and best practices
- Adds cross-references in both the main README.md and .github/copilot-instructions.md for better discoverability
- Establishes clear automation boundaries, particularly around sensitive operations like releases and security
Reviewed Changes
Copilot reviewed 3 out of 3 changed files in this pull request and generated 3 comments.
| File | Description |
|---|---|
| AGENTS.md | New comprehensive guide for AI agents with repository overview, supported actions, automation boundaries, workflows, and best practices |
| README.md | Adds reference to AGENTS.md in the Contribute section for AI agents and automated tools |
| .github/copilot-instructions.md | Adds prominent reference to AGENTS.md as the first bullet point for comprehensive agent guidance |
|
|
||
| ### Azure SDK Guidelines | ||
| - [Azure Go SDK Guidelines](https://azure.github.io/azure-sdk/golang_introduction.html) - Primary reference for SDK development | ||
| - [API Design Guidelines](https://azure.github.io/azure-sdk/golang_introduction.html) - API design principles |
There was a problem hiding this comment.
The API Design Guidelines link points to the same URL as the Azure Go SDK Guidelines above (line 217). This should link to a more specific API design section or be updated to reflect the actual API design guidelines URL.
| - [API Design Guidelines](https://azure.github.io/azure-sdk/golang_introduction.html) - API design principles | |
| - [API Design Guidelines](https://azure.github.io/azure-sdk/general_azure_sdk_api_design.html) - API design principles |
Copilot uses AI. Check for mistakes.
AGENTS.md
Outdated
| - **AutoRest/TypeSpec changes**: SDK generation from specifications requires specific tools and workflows (see [code generation docs](documentation/code-generation.md)) | ||
|
|
||
| #### Security and Compliance | ||
| - **CODEOWNERS modifications**: Changes require following [CODEOWNERS validation workflow](eng/common/instructions/azsdk-tools/validate-codeowners.instructions.md) |
There was a problem hiding this comment.
The referenced file path eng/common/instructions/azsdk-tools/validate-codeowners.instructions.md should be verified to exist in the repository. If this is an external reference or the path is incorrect, it should be updated or removed.
| - **CODEOWNERS modifications**: Changes require following [CODEOWNERS validation workflow](eng/common/instructions/azsdk-tools/validate-codeowners.instructions.md) | |
| - **CODEOWNERS modifications**: Changes require following the CODEOWNERS validation workflow (consult a maintainer or see internal documentation) |
Copilot uses AI. Check for mistakes.
AGENTS.md
Outdated
| go generate | ||
| ``` | ||
|
|
||
| See [TypeSpec location instructions](.github/instructions/tsp-location.instructions.md) for details. |
There was a problem hiding this comment.
The referenced file path .github/instructions/tsp-location.instructions.md should be verified to exist in the repository. If this file doesn't exist, the reference should be updated or removed.
| See [TypeSpec location instructions](.github/instructions/tsp-location.instructions.md) for details. | |
| <!-- TypeSpec location instructions file not found; reference removed to avoid broken link. --> |
Copilot uses AI. Check for mistakes.
There was a problem hiding this comment.
@copilot Avoid duplicating code in the Agents.md file. Where possible reference the content in README.MD and CONTRIBUTING.MD
AGENTS.md
Outdated
| - [Main README](README.md) - Getting started and package information | ||
| - [Contributing Guide](CONTRIBUTING.md) - Contribution guidelines and PR requirements | ||
| - [Developer Setup](documentation/developer_setup.md) - Environment setup for SDK development | ||
| - [Release Documentation](documentation/release.md) - Package release process | ||
| - [Copilot Instructions](.github/copilot-instructions.md) - Copilot-specific guidance |
There was a problem hiding this comment.
@copilot Use absolute link instead. Check here for more information: https://aka.ms/azsdk/guideline/links
There was a problem hiding this comment.
Updated all relative links to absolute GitHub URLs in commit 3d9f7ad. All internal documentation links now use the format https://github.com/Azure/azure-sdk-for-go/blob/main/<path> per the Azure SDK link guidelines.
RickWinter
requested review from
chlowell,
gracewilcox,
richardpark-msft and
sandeep-sen
Co-authored-by: RickWinter <4430337+RickWinter@users.noreply.github.com>
Reduced duplication in commit 3d9f7ad by:
Warning Firewall rules blocked me from connecting to one or more addresses (expand for details)I tried to connect to the following addresses, but was blocked by firewall rules:
If you need me to access, download, or install something from one of these locations, you can either:
|
3 participants
.github/copilot-instructions.mdto understand current agent guidanceAGENTS.mdfile at the root following canonical structure.github/copilot-instructions.mdSummary
Created a comprehensive
AGENTS.mdfile (220 lines) that provides guidance for AI agents interacting with the Azure SDK for Go repository.Recent Changes (commit 2)
https://github.com/Azure/azure-sdk-for-go/blob/main/<path>Key Sections
Cross-References
.github/copilot-instructions.mdas the first bullet pointOriginal prompt
Fixes #25393
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.