-
Notifications
You must be signed in to change notification settings - Fork 4.8k
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 Microsoft.Extensions.* package README files #92963
Comments
Tagging subscribers to this area: @dotnet/area-extensions-logging Issue Details(Fork of 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. 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. Additional contextYour 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 Templatehttps://raw.githubusercontent.com/lyndaidaii/NuGetReadMeTemplate/main/README.md
|
Tagging subscribers to this area: @dotnet/area-meta Issue Details(Fork of 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. 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. Additional contextYour 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 Templatehttps://raw.githubusercontent.com/lyndaidaii/NuGetReadMeTemplate/main/README.md
|
@ViktorHofer is tracking that in #92228 for all FX packages. There are some packages already covered in #91210. @ViktorHofer will be good to double check if your list is missing any package from what listed here. I'll let you decide if you want to keep this issue open or if your tracking is good enough. |
(Fork of 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.
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
The text was updated successfully, but these errors were encountered: