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 Microsoft.Extensions.* package README files #92963

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

Missing Microsoft.Extensions.* package README files #92963

Tratcher opened this issue Oct 3, 2023 · 4 comments

Comments

@Tratcher
Copy link
Member

Tratcher commented Oct 3, 2023

(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

Package Name Package Version Status Done
microsoft.extensions.caching.memory 7.0.0
microsoft.extensions.configuration 7.0.0
microsoft.extensions.configuration.abstractions 7.0.0
microsoft.extensions.configuration.binder 7.0.4
microsoft.extensions.configuration.environmentvariables 7.0.0
microsoft.extensions.configuration.fileextensions 7.0.0
microsoft.extensions.configuration.json 7.0.0
microsoft.extensions.configuration.usersecrets 7.0.0
microsoft.extensions.dependencyinjection 7.0.0
microsoft.extensions.dependencyinjection.abstractions 7.0.0
microsoft.extensions.hosting 7.0.1
microsoft.extensions.hosting.abstractions 7.0.0
microsoft.extensions.hosting.windowsservices 7.0.0
microsoft.extensions.http 7.0.0
microsoft.extensions.logging 7.0.0
microsoft.extensions.logging.abstractions 7.0.0
microsoft.extensions.logging.console 7.0.0
microsoft.extensions.options 7.0.1
microsoft.extensions.options.configurationextensions 7.0.0
@ghost ghost added the untriaged New issue has not been triaged by the area owner label Oct 3, 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 Oct 3, 2023
@ghost
Copy link

ghost commented Oct 3, 2023

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

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.
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
microsoft.extensions.caching.memory 7.0.0
microsoft.extensions.configuration 7.0.0
microsoft.extensions.configuration.abstractions 7.0.0
microsoft.extensions.configuration.binder 7.0.4
microsoft.extensions.configuration.environmentvariables 7.0.0
microsoft.extensions.configuration.fileextensions 7.0.0
microsoft.extensions.configuration.json 7.0.0
microsoft.extensions.configuration.usersecrets 7.0.0
microsoft.extensions.dependencyinjection 7.0.0
microsoft.extensions.dependencyinjection.abstractions 7.0.0
microsoft.extensions.hosting 7.0.1
microsoft.extensions.hosting.abstractions 7.0.0
microsoft.extensions.hosting.windowsservices 7.0.0
microsoft.extensions.http 7.0.0
microsoft.extensions.logging 7.0.0
microsoft.extensions.logging.abstractions 7.0.0
microsoft.extensions.logging.console 7.0.0
microsoft.extensions.options 7.0.1
microsoft.extensions.options.configurationextensions 7.0.0
Author: Tratcher
Assignees: -
Labels:

untriaged, area-Extensions-Logging, needs-area-label

Milestone: -

@Tratcher Tratcher removed the needs-area-label An area label is needed to ensure this gets routed to the appropriate area owners label Oct 3, 2023
@ghost
Copy link

ghost commented Oct 3, 2023

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

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.
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
microsoft.extensions.caching.memory 7.0.0
microsoft.extensions.configuration 7.0.0
microsoft.extensions.configuration.abstractions 7.0.0
microsoft.extensions.configuration.binder 7.0.4
microsoft.extensions.configuration.environmentvariables 7.0.0
microsoft.extensions.configuration.fileextensions 7.0.0
microsoft.extensions.configuration.json 7.0.0
microsoft.extensions.configuration.usersecrets 7.0.0
microsoft.extensions.dependencyinjection 7.0.0
microsoft.extensions.dependencyinjection.abstractions 7.0.0
microsoft.extensions.hosting 7.0.1
microsoft.extensions.hosting.abstractions 7.0.0
microsoft.extensions.hosting.windowsservices 7.0.0
microsoft.extensions.http 7.0.0
microsoft.extensions.logging 7.0.0
microsoft.extensions.logging.abstractions 7.0.0
microsoft.extensions.logging.console 7.0.0
microsoft.extensions.options 7.0.1
microsoft.extensions.options.configurationextensions 7.0.0
Author: Tratcher
Assignees: -
Labels:

area-Meta, untriaged

Milestone: -

@tarekgh
Copy link
Member

tarekgh commented Oct 3, 2023

@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.

@ViktorHofer
Copy link
Member

Yes, all of the packages in the above list are already tracked either by #91210 or #92228.

I would prefer to close this issue over #92228 which tracks the remaining work.

@ViktorHofer ViktorHofer closed this as not planned Won't fix, can't repro, duplicate, stale Oct 4, 2023
@ghost ghost removed the untriaged New issue has not been triaged by the area owner label Oct 4, 2023
@ghost ghost locked as resolved and limited conversation to collaborators Nov 3, 2023
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

3 participants