-
Notifications
You must be signed in to change notification settings - Fork 4.9k
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
Microsoft.Extensions.DependencyInjection NuGet Package Missing README File #86663
Comments
Tagging subscribers to this area: @dotnet/area-extensions-dependencyinjection Issue DetailsAs one of the top most installed NuGet packages, your Microsoft.Extensions.DependencyInjection package is extremely important to the developer ecosystem. 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. 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. 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.
|
There's already an issue for adding missing readmes for several NuGet packages: #59630. Should i close that big issue in favour of specific issues for each package? Or the opposite, specific issues should be closed as duplicates of the big one?
But note that runtime repository has guidelines for package readme: https://github.com/dotnet/runtime/blob/main/docs/coding-guidelines/libraries-packaging.md#package-readme |
As one of the top most installed NuGet packages, your Microsoft.Extensions.DependencyInjection package is extremely important to the developer ecosystem. 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.
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.
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.
The text was updated successfully, but these errors were encountered: