Update GHCP .NET custom instructions and how to#50570
Uh oh!
There was an error while loading. Please reload this page.
Conversation
There was a problem hiding this comment.
Pull request overview
This PR updates the GitHub Copilot app modernization documentation to reflect a new three-stage workflow (assessment, planning, and execution) for upgrading .NET applications. The changes provide clearer guidance on how developers interact with the modernization agent at each stage, including examples of the Markdown files generated during the process.
Key changes:
- Restructured the upgrade workflow from a single-phase approach to a three-stage process with distinct assessment, planning, and execution phases
- Updated examples to show the new Markdown documentation format generated at each stage (
assessment.md,plan.md,tasks.md) - Revised custom upgrade instructions guidance to emphasize integration during the assessment stage
Reviewed changes
Copilot reviewed 2 out of 4 changed files in this pull request and generated 25 comments.
| File | Description |
|---|---|
| how-to-upgrade-with-github-copilot.md | Rewrote to document the three-stage workflow with new section structure, updated examples, and clarified the role of each stage |
| how-to-custom-upgrade-instructions.md | Updated to align custom upgrade instructions with the new three-stage workflow, emphasizing assessment-stage integration |
| visualstudio-copilot-upgrade5.png | New or updated screenshot supporting the revised workflow documentation |
| visualstudio-copilot-upgrade6.png | New or updated screenshot supporting the revised workflow documentation |
| - [Executive Summary](#executive-Summary) | ||
| - [Highlevel Metrics](#highlevel-metrics) | ||
| - [Projects Compatibility](#projects-compatibility) | ||
| - [Package Compatibility](#package-compatibility) |
There was a problem hiding this comment.
Heading "Package Compatibility" should use sentence case: "Package compatibility".
| -[Package Compatibility](#package-compatibility) | |
| -[Package compatibility](#package-compatibility) |
| - [API Compatibility](#api-compatibility) | ||
| - [Aggregate NuGet packages details](#aggregate-nuget-packages-details) | ||
| - [Top API Migration Challenges](#top-api-migration-challenges) | ||
| - [Technologies and Features](#technologies-and-features) |
There was a problem hiding this comment.
Heading "Technologies and Features" should use sentence case: "Technologies and features".
| -[Technologies and Features](#technologies-and-features) | |
| -[Technologies and features](#technologies-and-features) |
| | Microsoft.EntityFrameworkCore.SqlServer | 6.0.0-rc.1.21452.10 | 9.0.5 | Recommended for .NET 9.0 | | ||
| | Microsoft.EntityFrameworkCore.Tools | 6.0.0-rc.1.21452.10 | 9.0.5 | Recommended for .NET 9.0 | | ||
| | Microsoft.VisualStudio.Web.CodeGeneration.Design | 6.0.0-rc.1.21464.1 | 9.0.0 | Recommended for .NET 9.0 | | ||
| ## Table of Contents |
There was a problem hiding this comment.
Heading "Table of Contents" should use sentence case: "Table of contents".
| ## Table of Contents | |
| ## Table of contents |
| | Microsoft.VisualStudio.Web.CodeGeneration.Design | 6.0.0-rc.1.21464.1 | 9.0.0 | Recommended for .NET 9.0 | | ||
| ## Table of Contents | ||
| - [Executive Summary](#executive-summary) |
There was a problem hiding this comment.
Heading "Executive Summary" should use sentence case: "Executive summary".
| ## Table of Contents | ||
| - [Executive Summary](#executive-summary) | ||
| - [Migration Strategy](#migration-strategy) |
There was a problem hiding this comment.
Heading "Migration Strategy" should use sentence case: "Migration strategy".
| -[Migration Strategy](#migration-strategy) | |
| -[Migration strategy](#migration-strategy) |
| --- | ||
| ## Executive Summary |
There was a problem hiding this comment.
Heading "Executive Summary" should use sentence case: "Executive summary".
| - **WpfMovie**: Windows Presentation Foundation desktop application | ||
| - **3 Test Projects**: Unit test projects for each application | ||
| ### Scope & Current State |
There was a problem hiding this comment.
Heading "Scope & Current State" should use sentence case: "Scope and current state".
| ### Scope & Current State | |
| ### Scope and current state |
| The planning stage converts the assessment into a detailed specification that explains how to resolve every issue. When you tell Copilot to proceed to planning, it generates a `plan.md` file in `.github/upgrades`. | ||
| The plan documents upgrade strategies, refactoring approaches, dependency upgrade paths, and risk mitigations. The following example shows part of a plan for an ASP.NET Core project: |
There was a problem hiding this comment.
Missing Oxford comma. The list should use Oxford comma format: "upgrade strategies, refactoring approaches, dependency upgrade paths, and risk mitigations."
| For example, when replacing Newtonsoft, the assessment identifies: | ||
| - Projects using `Newtonsoft.Json` packages. | ||
| - Code patterns that need refactoring to use `System.Text.Json`. | ||
| - Dependencies that need to be removed or replaced. |
There was a problem hiding this comment.
Missing Oxford comma. The list should use Oxford comma format: "Projects using Newtonsoft.Json packages, Code patterns that need refactoring to use System.Text.Json, and Dependencies that need to be removed or replaced." Note that each bullet point should be a complete sentence with proper punctuation according to .NET documentation guidelines.
| ## Table of Contents | ||
| ## Settings | ||
| - [Executive Summary](#executive-Summary) |
There was a problem hiding this comment.
The heading uses inconsistent capitalization. "Executive Summary" should use sentence case ("Executive summary") to match .NET documentation guidelines.
| -[Executive Summary](#executive-Summary) | |
| -[Executive summary](#executive-summary) |
Summary
Rewrote the howto and custom articles to detail the new workflow
Internal previews