Skip to content
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

[IMPROVEMENT] Nuget Readme included in the package #804

Merged
merged 7 commits into from
Oct 30, 2023

Conversation

moljac
Copy link
Member

@moljac moljac commented Oct 1, 2023

Does this change any of the generated binding API's?

No.

Describe your contribution

NuGet best practices recommend adding readme.[txt,md] to each package. Otherwise following warning is emitted:

The package  is missing a readme. Go to https://aka.ms/nuget/authoring-best-practices/readme to learn why package readmes are important.

This PR adds readme.md to NuGet packages.

https://devblogs.microsoft.com/nuget/add-a-readme-to-your-nuget-package/

https://devblogs.microsoft.com/nuget/write-a-high-quality-readme-for-nuget-packages/

NuGet/Home#12070

https://raw.githubusercontent.com/lyndaidaii/NuGetReadMeTemplate/main/README.md

Verification

Result:

@moljac moljac requested a review from jpobst October 30, 2023 13:56

Google.Play.Services, Firebase and ML Kit (GPS-FB-MLKit) Bindings NuGet Package @(Model.NuGetPackageId)

.NET for Android (formerly Xamarin.Android) GPS-FB-MLKit bindings NuGet Package @(Model.NuGetPackageId)
Copy link
Contributor

Choose a reason for hiding this comment

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

The name they finally decided on is .NET Android.

source/GooglePlayServicesNuGetReadMe.cshtml Outdated Show resolved Hide resolved
source/GooglePlayServicesNuGetReadMe.cshtml Outdated Show resolved Hide resolved
source/GooglePlayServicesNuGetReadMe.cshtml Outdated Show resolved Hide resolved
@moljac moljac merged commit cae09fd into main Oct 30, 2023
1 of 4 checks passed
@moljac moljac deleted the mu-20231001-nuget-readme branch October 30, 2023 19:35
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants