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

Missing package README file #31947

Closed
Tratcher opened this issue Oct 3, 2023 · 0 comments
Closed

Missing package README file #31947

Tratcher opened this issue Oct 3, 2023 · 0 comments
Assignees
Labels
area-docs closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. Servicing-approved type-enhancement
Milestone

Comments

@Tratcher
Copy link
Member

Tratcher commented Oct 3, 2023

(Forked from dotnet/aspnetcore#48392)

The NuGet team has noticed that your package on NuGet.org is missing a README file. Please take a moment to add a README file to your package repository.

Our customer research indicates that one of the top problems that package consumers face is insufficient package documentation such as README files. Adding a README file to your package will help users quickly understand what the package is and what it does. Since your README will be the first impression for users when they view your package on NuGet.org, it is crucial for authors to write and include high-quality READMEs for their packages.

Describe the solution you'd like

Please add a README file to your package so that users can understand at a glance what the package contains and how to use it.

There is no specific format or structure to a good README – instead it’s about effectively communicating the purpose and functionality of your package to potential users. If you are unsure of where to start, check out our blog post for some README best practices and a template file.
If you are new to NuGet README, learn more about how to add a README to your NuGet Package.

Additional context

Your feedback is very important to us. If you experience any issue using READMEs or have ideas for improvements – please feel free to contact us by replying to this issue

README Template

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

Package Name Package Version Status Done
dotnet-ef 7.0.4
entityframework 6.4.4
microsoft.data.sqlite 7.0.4
microsoft.data.sqlite.core 7.0.4
microsoft.entityframeworkcore 7.0.4
microsoft.entityframeworkcore.abstractions 7.0.4
microsoft.entityframeworkcore.analyzers 7.0.4
microsoft.entityframeworkcore.design 7.0.4
microsoft.entityframeworkcore.inmemory 7.0.4
microsoft.entityframeworkcore.proxies 7.0.4
microsoft.entityframeworkcore.relational 7.0.4
microsoft.entityframeworkcore.sqlite 7.0.4
microsoft.entityframeworkcore.sqlite.core 7.0.4
microsoft.entityframeworkcore.sqlserver 7.0.4
microsoft.entityframeworkcore.sqlserver.design 1.1.6
microsoft.entityframeworkcore.tools 7.0.4
microsoft.entityframeworkcore.tools.dotnet 2.0.3
@ajcvickers ajcvickers added this to the Backlog milestone Oct 11, 2023
ajcvickers added a commit that referenced this issue Jan 30, 2024
Part of #31947

This PR includes the content. I still don't know what needs to be done, if anything, to ensure the content is actually included in the packages.
ajcvickers added a commit that referenced this issue Jan 31, 2024
Part of #31947

This PR includes the content. I still don't know what needs to be done, if anything, to ensure the content is actually included in the packages.
@ajcvickers ajcvickers self-assigned this Jan 31, 2024
@ajcvickers ajcvickers modified the milestones: Backlog, 8.0.x Jan 31, 2024
@ajcvickers ajcvickers added Servicing-consider closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. labels Jan 31, 2024
ajcvickers added a commit that referenced this issue Jan 31, 2024
Part of #31947

This PR includes the content. I still don't know what needs to be done, if anything, to ensure the content is actually included in the packages.
ajcvickers added a commit that referenced this issue Jan 31, 2024
* NuGet package readme files

Part of #31947

This PR includes the content. I still don't know what needs to be done, if anything, to ensure the content is actually included in the packages.

* Update build to include readmes

* Update Tools nuspec
ajcvickers added a commit that referenced this issue Jan 31, 2024
* NuGet package readme files

Part of #31947

This PR includes the content. I still don't know what needs to be done, if anything, to ensure the content is actually included in the packages.

* Update build to include readmes

* Update Tools nuspec
@ajcvickers ajcvickers modified the milestones: 8.0.x, 8.0.3 Feb 2, 2024
maumar pushed a commit that referenced this issue Feb 6, 2024
* NuGet package readme files

Part of #31947

This PR includes the content. I still don't know what needs to be done, if anything, to ensure the content is actually included in the packages.

* Update build to include readmes

* Update Tools nuspec
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-docs closed-fixed The issue has been fixed and is/will be included in the release indicated by the issue milestone. Servicing-approved type-enhancement
Projects
None yet
Development

No branches or pull requests

2 participants