Sitelet https://github.com/Azure/azure-sdk-for-net/blob/main/.github/copilot-instructions.md
Skip to content

copilot-instructions.md

Latest commit

 

History

History
50 lines (33 loc) · 3.42 KB

copilot-instructions.md

File metadata and controls

50 lines (33 loc) · 3.42 KB
Raw

Project Overview

Note: For general AI agent guidelines and repository overview, see AGENTS.md at the repository root.

This repo contains Azure SDKs for various Azure services and tools that generate them.

Prerequisites

  • To use MCP tool calls, PowerShell must be installed. Provide PowerShell installation instructions if not installed, and recommend restarting the IDE to use the MCP server.
  • When using Copilot from Visual Studio or VS Code (not applicable when using Coding Agent on Github.com):
    • Always run the azsdk_verify_setup tool first to validate the user's development environment for SDK MCP tools.
    • Do not proceed with any other tool execution until this step is complete.
    • Skip this check only for queries that do not require tool execution.

Folder Structure

  • /eng/packages/http-client-csharp: Contains the source code of the generator for Azure Data Plane SDKs (aka Azure Generator).
  • /eng/packages/http-client-csharp-mgmt: Contains the source code of the generator for Azure Management Plane SDKs (aka Azure Management Generator).
  • /sdk: Contains the individual SDKs for Azure services.

Azure Generator

  • Always run npm install in the /eng/packages/http-client-csharp directory before running the generator.
  • Always run /eng/packages/http-client-csharp/eng/scripts/Generate.ps1 to regenerate the test projects to validate the result of generator code changes.
  • For emitter changes, always run npm run lint and npm run prettier in the /eng/packages/http-client-csharp directory to ensure the changes won't break CI.

Azure Management Generator

  • Always run npm install in the /eng/packages/http-client-csharp-mgmt directory before running the generator.
  • Always run /eng/packages/http-client-csharp-mgmt/eng/scripts/Generate.ps1 to regenerate the test projects to validate the result of generator code changes.
  • For emitter changes, always run npm run lint and npm run prettier in the /eng/packages/http-client-csharp-mgmt directory to ensure the changes won't break CI.

Local SDK Generation and Package Lifecycle (TypeSpec)

AUTHORITATIVE REFERENCE

For all TypeSpec-based SDK workflows (generation, building, validation, testing, versioning, and release preparation), follow #file:../eng/common/instructions/azsdk-tools/local-sdk-workflow.instructions.md

DEFAULT BEHAVIORS

  • Repository: Use the current workspace as the local SDK repository unless the user specifies a different path.
  • Configuration: Identify tsp-location.yaml from files open in the editor. If unclear, ask the user.

REQUIRED CONFIRMATIONS

Ask the user for clarification if repository path or configuration file is ambiguous.

SDK release

For detailed workflow instructions, see SDK Release.

Pre-Commit Validation

Before committing changes to SDK packages under sdk/, always run the pre-commit validation checks described in the pre-commit-checks skill. These checks run dotnet format, regenerate public API listings, update snippets, and regenerate code as needed. They may produce additional file changes that must be included in the commit.