Generate GitHub Copilot instructions with clear module vs project architecture

[Copilot]

This PR adds comprehensive GitHub Copilot instructions to help developers work effectively in the Azure PowerShell repository. The instructions provide detailed guidance for building, testing, and developing in this complex codebase containing 200+ PowerShell modules.

Architecture Clarification

A key focus of these instructions is properly distinguishing the repository's architecture:

• Module: A complete PowerShell module (e.g., Az.Compute) that can consist of multiple projects
• Project: Individual C# project within a module, developed with one approach (SDK-based OR AutoRest)
• Hybrid Module: Contains both SDK-based and AutoRest projects (e.g., Az.Resources with both approaches)

The development approaches (SDK-based vs AutoRest-based) apply to individual projects within modules, not entire modules themselves, since modules can be hybrid containing both types of projects.

Key Features

Build System Guidance

• Complete MSBuild command reference with exact timing expectations
• Critical timing documentation: Full builds take 45-60 minutes, single modules 15-30 minutes
• "NEVER CANCEL" warnings with specific timeout values to prevent premature build termination
• Network connectivity requirements for Azure DevOps package feeds

Prerequisites and Setup

• Exact installation commands for .NET SDK 8+, PowerShell 7+, platyPS, PSScriptAnalyzer
• Environment setup requirements and execution policy configuration
• Troubleshooting for common setup issues

Manual Validation Scenarios

The instructions emphasize that building alone is insufficient - developers must manually test functionality:

# Import the built module
Import-Module ./artifacts/Debug/Az.YourModule/Az.YourModule.psd1

# Verify cmdlets work correctly
Get-Command -Module Az.YourModule
Get-Help Your-AzCmdlet -Examples

# Test real scenarios with error handling
Your-AzCmdlet -ResourceGroupName "test-rg"

Repository Structure Explanation

• Distinction between SDK-based projects and AutoRest-generated projects
• Development workflows for both project types within modules
• Key directories and their purposes

Comprehensive Troubleshooting

• Network connectivity issues with specific domain requirements
• Build artifact problems and solutions
• PowerShell module import troubleshooting
• Common error patterns and workarounds

Timing Expectations

Command	Expected Time	Timeout Setting
Full repository build	45-60 minutes	90 minutes
Single module build	15-30 minutes	45 minutes
Help generation	10-15 minutes	30 minutes
Static analysis	10-15 minutes	30 minutes

The instructions begin with a firm directive to follow these guidelines first before searching for additional context, ensuring Copilot prioritizes the documented workflows over generic approaches.

Fixes #28401.

---

💡 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.

[azure-client-tools-bot-prd]

Thanks for your contribution! The pull request validation has started. Please revisit this comment for updated status.

[isra-fel]

@copilot Can you check my previous PR #28381 and distinguish module vs. project and be clear that the two development modes apply to projects instead of modules because modules can be hybrid.

[isra-fel]

@copilot Can you check my previous PR #28381 and make sure you distinguish module vs. project in the instructions and be clear that the two development modes apply to projects instead of modules because modules can be hybrid.

[Copilot]

@copilot Can you check my previous PR #28381 and distinguish module vs. project and be clear that the two development modes apply to projects instead of m...

I've updated the instructions to correctly distinguish between modules and projects. The terminology now clarifies that development approaches (SDK-based vs AutoRest-based) apply to individual projects within modules, not entire modules, since modules can be hybrid containing both types of projects. Added an Architecture Overview section explaining this distinction and updated all references throughout the document. See commit eb4147c.

@copilot Can you check my previous PR #28381 and make sure you distinguish module vs. project in the instructions and be clear that the two development m...

I've corrected the terminology throughout the instructions to distinguish modules vs projects. The document now clearly explains that:

• Module: A complete PowerShell module (e.g., Az.Compute) that can consist of multiple projects
• Project: Individual C# project within a module, developed with one approach (SDK-based OR AutoRest)
• Hybrid Module: Contains both SDK-based and AutoRest projects

Updated all sections to refer to "SDK-based projects" and "AutoRest-based projects" instead of modules. See commit eb4147c.

[isra-fel]

LGTM

[Copilot]

Pull Request Overview

This PR adds comprehensive GitHub Copilot instructions to help developers work effectively in the Azure PowerShell repository, focusing on the distinction between modules and projects within the complex multi-approach architecture.

• Provides clear guidance on build system usage with critical timing expectations and "NEVER CANCEL" warnings
• Establishes manual validation workflows that emphasize testing functionality beyond just building
• Documents the hybrid architecture where modules can contain both SDK-based and AutoRest-generated projects

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

[isra-fel]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).