-
Notifications
You must be signed in to change notification settings - Fork 3.3k
update #938
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
base: main
Are you sure you want to change the base?
update #938
Conversation
|
@Ping-Wu1 please read the following Contributor License Agreement(CLA). If you agree with the CLA, please reply with the following information.
Contributor License AgreementContribution License AgreementThis Contribution License Agreement ( “Agreement” ) is agreed to by the party signing below ( “You” ), 1. Definitions. “Code” means the computer software code, whether in human-readable or machine-executable form, “Project” means any of the projects owned or managed by .NET Foundation and offered under a license “Submit” is the act of uploading, submitting, transmitting, or distributing code or other content to any “Submission” means the Code and any other copyrightable material Submitted by You, including any 2. Your Submission. You must agree to the terms of this Agreement before making a Submission to any 3. Originality of Work. You represent that each of Your Submissions is entirely Your 4. Your Employer. References to “employer” in this Agreement include Your employer or anyone else 5. Licenses. a. Copyright License. You grant .NET Foundation, and those who receive the Submission directly b. Patent License. You grant .NET Foundation, and those who receive the Submission directly or c. Other Rights Reserved. Each party reserves all rights not expressly granted in this Agreement. 6. Representations and Warranties. You represent that You are legally entitled to grant the above 7. Notice to .NET Foundation. You agree to notify .NET Foundation in writing of any facts or 8. Information about Submissions. You agree that contributions to Projects and information about 9. Governing Law/Jurisdiction. This Agreement is governed by the laws of the State of Washington, and 10. Entire Agreement/Assignment. This Agreement is the entire agreement between the parties, and .NET Foundation dedicates this Contribution License Agreement to the public domain according to the Creative Commons CC0 1. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Pull request overview
This pull request adds comprehensive documentation for .NET 10 Preview support to the eShop reference application. However, the documentation has significant issues with formatting consistency, factual accuracy regarding the repository's existing global.json configuration, and contradictions about .NET 9 support.
Key Changes:
- Adds a new .NET 10 Support section explaining installation, usage, and compatibility
- Documents troubleshooting steps for .NET 10 Preview
- Provides examples for Docker container images and global.json configuration
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
|
|
||
| The eShop project now includes support for .NET 10 Preview, allowing developers to take advantage of the newest runtime improvements, performance updates, and ASP.NET Core features. While .NET 9 remains fully supported, users running newer SDKs can build and run the application on .NET 10 without making any code changes. | ||
|
|
||
| Install the .NET 10 Preview SDK |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section heading is missing proper Markdown formatting. It should be formatted as a heading using hash symbols (e.g., ### Install the .NET 10 Preview SDK) to be properly rendered and maintain document hierarchy.
| Install the .NET 10 Preview SDK | |
| ### Install the .NET 10 Preview SDK |
|
|
||
| You should see a version starting with 10.0. | ||
|
|
||
| Running the application with .NET 10 |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section heading is missing proper Markdown formatting. It should be formatted as a heading using hash symbols (e.g., ### Running the application with .NET 10) to maintain consistent document structure.
| Running the application with .NET 10 | |
| ### Running the application with .NET 10 |
| This version of eShop is based on .NET 9. | ||
| [.NET 10 Support] | ||
|
|
||
| The eShop project now includes support for .NET 10 Preview, allowing developers to take advantage of the newest runtime improvements, performance updates, and ASP.NET Core features. While .NET 9 remains fully supported, users running newer SDKs can build and run the application on .NET 10 without making any code changes. |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The documentation claims that .NET 9 remains fully supported, but the repository's global.json file explicitly specifies version "10.0.100", which forces the use of .NET 10. This creates a contradiction - developers cannot use .NET 9 if the global.json enforces .NET 10. Either the global.json should be updated to allow .NET 9, or this statement should be corrected to reflect the actual requirement.
| { | ||
| "sdk": { | ||
| "version": "10.0.0-preview.1" | ||
| } | ||
| } |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The JSON code block should be formatted with triple backticks and a language identifier (```json) to match the formatting style used elsewhere in the README (see lines 166-170) and ensure proper syntax highlighting.
|
|
||
| Once .NET 10 Preview is installed, you can run eShop exactly the same way: | ||
|
|
||
| dotnet run --project src/eShop.AppHost/eShop.AppHost.csproj |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The command should be formatted as a code block using triple backticks to match the style used elsewhere in the README (see lines 152-154). This ensures proper syntax highlighting and consistent documentation formatting.
| .NET 10 is still in preview, so APIs and tooling may change. | ||
|
|
||
| Some IDEs, such as Visual Studio, may require the latest preview version to fully support .NET 10 projects. | ||
|
|
||
| Docker container images for .NET 10 Preview must be pulled manually if using containerized builds. | ||
|
|
||
| Example Docker base image: | ||
|
|
||
| FROM mcr.microsoft.com/dotnet/aspnet:10.0-preview |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The bullet points in this section should be formatted as a proper Markdown list with dashes or asterisks at the beginning of each line. The current format lacks list markers, which makes the content harder to read and inconsistent with Markdown best practices.
|
|
||
| Example Docker base image: | ||
|
|
||
| FROM mcr.microsoft.com/dotnet/aspnet:10.0-preview |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The code snippet should be formatted as a proper code block with triple backticks and a language identifier (e.g., ```dockerfile) to match the formatting style used elsewhere in the README and ensure proper syntax highlighting.
|
|
||
| Rebuild NuGet packages: | ||
|
|
||
| dotnet restore --force |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The command should be formatted as a code block using triple backticks to match the style used elsewhere in the README. This ensures proper syntax highlighting and consistent documentation formatting.
|
|
||
| Clear old build outputs: | ||
|
|
||
| dotnet clean |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The command should be formatted as a code block using triple backticks to match the style used elsewhere in the README. This ensures proper syntax highlighting and consistent documentation formatting.
|
|
||
| If .NET 10 does not appear in the list, reinstall the SDK. | ||
|
|
||
| Ongoing updates |
Copilot
AI
Dec 12, 2025
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This section heading is missing proper Markdown formatting. It should be formatted as a heading using hash symbols (e.g., ### Ongoing updates) to maintain consistent document structure.
| Ongoing updates | |
| ### Ongoing updates |
I updated the README to add a complete .NET 10 Preview Support section. The new content explains how to install the .NET 10 SDK, run eShop using the updated runtime, configure global.json, handle preview compatibility, troubleshoot build issues, and use .NET 10 container images. This update makes the documentation clearer for developers using newer .NET versions and ensures the project instructions stay up to date with the latest SDK releases. Closes #902