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

Microsoft.Extensions.DependencyInjection NuGet Package Missing README File #86663

Closed
mckennabarlow opened this issue May 23, 2023 · 3 comments
Closed
Labels
area-Extensions-DependencyInjection documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Milestone

Comments

@mckennabarlow
Copy link

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.

@ghost ghost added the untriaged New issue has not been triaged by the area owner label May 23, 2023
@dotnet-issue-labeler dotnet-issue-labeler bot added the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label May 23, 2023
@ghost
Copy link

ghost commented May 23, 2023

Tagging subscribers to this area: @dotnet/area-extensions-dependencyinjection
See info in area-owners.md if you want to be subscribed.

Issue Details

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.

Author: mckennabarlow
Assignees: -
Labels:

untriaged, area-Extensions-DependencyInjection, needs-area-label

Milestone: -

@jkotas jkotas removed the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label May 23, 2023
@steveharter steveharter added documentation Documentation bug or enhancement, does not impact product or test code and removed untriaged New issue has not been triaged by the area owner labels Jun 28, 2023
@steveharter steveharter added this to the 8.0.0 milestone Jun 28, 2023
@steveharter steveharter added the help wanted [up-for-grabs] Good issue for external contributors label Jun 28, 2023
@MSDN-WhiteKnight
Copy link
Contributor

MSDN-WhiteKnight commented Jul 14, 2023

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?

There is no specific format or structure to a good README

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

@ericstj
Copy link
Member

ericstj commented Sep 9, 2023

Closing this in favor of #59630. This particular library will be addressed with #91210 which will be merged for 8.0 RC2

@ericstj ericstj closed this as completed Sep 9, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Oct 9, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
area-Extensions-DependencyInjection documentation Documentation bug or enhancement, does not impact product or test code help wanted [up-for-grabs] Good issue for external contributors
Projects
None yet
Development

No branches or pull requests

5 participants