🧠 Generate Copilot Agent Instructions for Azure DevOps Migration Tools

[Copilot]

This PR creates comprehensive GitHub Copilot instructions to enhance code assistance by documenting the application structure and key components of the Azure DevOps Migration Tools.

📄 What's Added

Created .github/copilot-instructions.md with detailed documentation of all executable assemblies and their architecture patterns.

🎯 Executable Assemblies Documented

1. MigrationTools.ConsoleCore

• Purpose: Modern .NET 8.0 REST API-based migration tool (cross-platform)
• Assembly: devopsmigration
• Pattern: MigrationToolHost.CreateDefaultBuilder() → RunConsoleAsync()
• Focus: Lightweight, REST-only migrations

2. MigrationTools.ConsoleFull

• Purpose: Full-featured .NET Framework 4.7.2 migration tool (Windows-specific)
• Assembly: devopsmigration
• Pattern: Dynamic assembly loading → MigrationToolHost.CreateDefaultBuilder() → RunConsoleAsync()
• Focus: Complete TFS Object Model + REST API support

3. MigrationTools.ConsoleDataGenerator

• Purpose: Documentation generation utility using reflection
• Pattern: Standard Main() with assembly discovery and type reflection
• Focus: Auto-generates YAML/Markdown documentation

4. MigrationTools.Telemetery

• Purpose: Azure Functions v4 telemetry collection service
• Pattern: HostBuilder().ConfigureFunctionsWebApplication() → host.Run()
• Focus: Application Insights integration and monitoring

🏗️ Additional Context Provided

• MigrationToolHost common infrastructure patterns
• V1 vs V2 Architecture guidance (legacy TFS Object Model vs modern REST patterns)
• CLI Commands: execute, init, upgrade, builder
• Configuration Templates: Basic, Full, WorkItemTracking, Fullv2, WorkItemTrackingv2
• Copilot-specific notes for each component to improve code suggestions

🎁 Benefits for Copilot

The documentation enables GitHub Copilot to:

• Understand the dual-runtime architecture (.NET 8.0 vs .NET Framework 4.7.2)
• Distinguish between REST API and TFS Object Model patterns
• Provide context-aware suggestions based on the specific executable being worked on
• Recommend appropriate patterns for v1 (legacy) vs v2 (modern) architectures

Fixes #2741.

---

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

[MrHinsh]

There should be no v1/v2 architecture in the code any more.

[Copilot]

There should be no v1/v2 architecture in the code any more.

You're absolutely right. I've removed all v1/v2 architecture references from the Copilot instructions and replaced them with the more accurate TFS Object Model vs REST API distinction. The configuration templates have also been updated to match the actual available options in the codebase. Changes in commit 9d1b10d.

[nkdagility-actions-bot]

Azure Static Web Apps: Your stage site is ready! Visit it here: https://blue-river-093197403-2742.westeurope.5.azurestaticapps.net

[MrHinsh]

Add instructions that when editing classes to ensure that the documentation pages are also updated in /docs/ and that the samples in the markdown copy refpect the current version of the classes properties.

I want any changes to be checked against the class data so that it reflect what is actually there.

[Copilot]

Add instructions that when editing classes to ensure that the documentation pages are also updated in /docs/ and that the samples in the markdown copy refpect the current version of the classes proper...

Added comprehensive documentation synchronization requirements to the Copilot instructions. The new section provides step-by-step guidance for keeping documentation in sync with code changes, including XML documentation updates, ConsoleDataGenerator execution, and validation checklists to ensure configuration samples accurately reflect class properties. Changes in commit e492673.

[nkdagility-actions-bot]

Azure Static Web Apps: Your stage site is ready! Visit it here: https://blue-river-093197403-2742.westeurope.5.azurestaticapps.net