Movatterモバイル変換

[0]ホーム
URL:

Skip to content

Navigation Menu

Sign in
Appearance settings

Search code, repositories, users, issues, pull requests...

Provide feedback

We read every piece of feedback, and take your input very seriously.

Saved searches

Use saved searches to filter your results more quickly

 Sign up
Appearance settings

Add comprehensive README to Microsoft.Maui.Controls NuGet package#32835

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 ourterms of service andprivacy statement. We’ll occasionally send you account related emails.

Already on GitHub?Sign in to your account

Draft
Copilot wants to merge5 commits intomain
base:main
Choose a base branch
Loading
fromcopilot/improve-maui-nuget-readme

Conversation

Copy link
Contributor

CopilotAI commentedNov 24, 2025•
edited
Loading

Note

Are you waiting for the changes in this PR to be merged?
It would be very helpful if you couldtest the resulting artifacts from this PR and let us know in a comment if this change resolves your issue. Thank you!

Description of Change

Adds a high-quality README to the Microsoft.Maui.Controls NuGet package followingMicrosoft's official guidelines. The README will render on NuGet.org's package page.

Changes:

  • Created/src/Controls/src/NuGet/README.md with:
    • Uses product name ".NET MAUI" throughout (not package name)
    • Feature overview (40+ controls, XAML, layouts, navigation, data binding, theming)
    • Platform support matrix (Android, iOS, iPadOS, macOS, Windows with minimum versions)
    • Getting started guide (installation, project creation, platform-specific run commands)
    • Complete XAML + C# quick start example with correctBackground property
    • Key feature examples including:
      • MVVM and Data Binding
      • XAML Enhancements (XAML Source Generation and simplifications)
      • Shell navigation
      • CollectionView
      • Responsive layouts
    • Documentation links (Microsoft Learn, API reference, samples, tutorials)
    • Support channels (Stack Overflow, GitHub issues, official .NET Discord, community MAUIverse Discord, security reporting)
    • Community resources (X/Twitter, YouTube)
    • Contributing guidelines and related packages
  • UpdatedControls.NuGet.csproj with:
    • PackageReadmeFile property
    • ItemGroup to pack README into NuGet package

Structure modeled afterOpenAI .NET SDK README.

Example quick start:

<ContentPagexmlns="http://schemas.microsoft.com/dotnet/2021/maui"xmlns:x="http://schemas.microsoft.com/winfx/2009/xaml"x:Class="MyMauiApp.MainPage"Background="{DynamicResource PageBackgroundColor}">    <VerticalStackLayoutSpacing="25"Padding="30">        <ImageSource="dotnet_bot.png"HeightRequest="185" />        <LabelText="Hello, .NET MAUI!" />        <EntryPlaceholder="Enter your name"x:Name="NameEntry" />        <ButtonText="Click Me"Clicked="OnCounterClicked" />    </VerticalStackLayout></ContentPage>

Issues Fixed

Fixes#26051

Original prompt

This section details on the original issue you should resolve

<issue_title>Improve the MAUI Nuget readme.md file</issue_title>
<issue_description>### Description

Please refer toWrite a high-quality README for NuGet packages - .NET Blog.

Example of a quality ReadMe fileNuGet Gallery | OpenAI 2.5.0 package.</issue_description>

<agent_instructions>Based onhttps://devblogs.microsoft.com/dotnet/write-a-high-quality-readme-for-nuget-packages/ (description on what is important in a README) andhttps://github.com/openai/openai-dotnet/blob/main/README.md (a great example of a README) can you suggest a good README for the Microsoft.Maui.Controls package and make sure its included so that it shows in the NuGet.org package explorer?

Do extensive (online) research on what to include and what to describe.</agent_instructions>

Comments on the Issue (you are@copilot in this section)

✨ Let Copilot coding agentset things up for you — coding agent works faster and does higher quality work when set up for your repo.

Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
CopilotAI changed the title[WIP] Improve the MAUI NuGet readme.md fileAdd comprehensive README to Microsoft.Maui.Controls NuGet packageNov 24, 2025
Copilot finished work on behalf ofjfversluisNovember 24, 2025 15:46
@jfversluis
Copy link
Member

@copilot lets not call it .NET MAUI Controls, although the package is called like that, lets just refer to the product name: .NET MAUI

Co-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
Copy link
ContributorAuthor

@copilot lets not call it .NET MAUI Controls, although the package is called like that, lets just refer to the product name: .NET MAUI

Updated to use the product name ".NET MAUI" instead of ".NET MAUI Controls" in the title and section headers. Changes committed inbef71ee.

Copilot finished work on behalf ofjfversluisNovember 24, 2025 16:21
Comment on lines +69 to +82
Run on Android:
```bash
dotnet build -t:Run -f net10.0-android
```

Run on iOS (Mac only):
```bash
dotnet build -t:Run -f net10.0-ios
```

Run on Windows:
```bash
dotnet build -t:Run -f net10.0-windows
```
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I think we can just use dotnet run now instead of -t:Run, check online then update this if this statement is true

Copy link
ContributorAuthor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others.Learn more.

I researched this anddotnet build -t:Run is still the recommended approach for .NET MAUI projects due to their multi-targeting nature and platform-specific requirements.dotnet run can encounter issues with launch profiles and platform-specific tasks in MAUI projects. Keeping the current commands.

@jfversluis
Copy link
Member

@copilot address comments

PureWeen reacted with heart emoji

…s, update Discord/social linksCo-authored-by: jfversluis <939291+jfversluis@users.noreply.github.com>
Copilot finished work on behalf ofjfversluisNovember 24, 2025 19:58
Sign up for freeto join this conversation on GitHub. Already have an account?Sign in to comment

Reviewers

@jfversluisjfversluisAwaiting requested review from jfversluis

At least 1 approving review is required to merge this pull request.

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Improve the MAUI Nuget readme.md file

2 participants

@jfversluis
[8]ページ先頭
©2009-2025 Movatter.jp